diff --git a/docs/api.md b/docs/api.md index d1923cb281..6c33152ef7 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,26 +2,36 @@ ```mermaid classDiagram class RapidataClient { - +RapidataOrderManager order - +RapidataValidationManager validation + +RapidataJobManager job + +RapidataAudienceManager audience + +ValidationSetManager validation + +RapidataFlowManager flow + +RapidataBillingManager billing } - - class RapidataOrderManager { + + class RapidataJobManager { +RapidataFilters filter +RapidataSettings settings +RapidataSelections selections - +create_****_order() - +get_order_by_id() - +find_orders() + +create_****_job_definition() + +get_job_definition_by_id() + +get_job_by_id() + +find_jobs() + } + + class RapidataAudienceManager { + +create_audience() + +get_audience_by_id() + +assign_job() } - - class RapidataValidationManager { + + class ValidationSetManager { +RapidsManager rapid +create_****_set() +get_validation_set_by_id() +find_validation_sets() } - + class RapidataFilters { +Country +Language @@ -50,21 +60,22 @@ classDiagram +Capped +Shuffling } - + class RapidsManager { +****_rapid() } - RapidataClient --* RapidataOrderManager - RapidataClient --* RapidataValidationManager - RapidataOrderManager --* RapidataFilters - RapidataOrderManager --* RapidataSettings - RapidataOrderManager --* RapidataSelections - RapidataValidationManager --* RapidsManager + RapidataClient --* RapidataJobManager + RapidataClient --* RapidataAudienceManager + RapidataClient --* ValidationSetManager + RapidataJobManager --* RapidataFilters + RapidataJobManager --* RapidataSettings + RapidataJobManager --* RapidataSelections + ValidationSetManager --* RapidsManager link RapidataClient "../reference/rapidata/rapidata_client/rapidata_client/" "" - link RapidataOrderManager "../reference/rapidata/rapidata_client/order/rapidata_order_manager/" "" - link RapidataValidationManager "../reference/rapidata/rapidata_client/validation/validation_set_manager/" "" + link RapidataJobManager "../reference/rapidata/rapidata_client/job/rapidata_job_manager/" "" + link ValidationSetManager "../reference/rapidata/rapidata_client/validation/validation_set_manager/" "" link RapidataFilters "../reference/rapidata/rapidata_client/filter/rapidata_filters/" "" link RapidataSettings "../reference/rapidata/rapidata_client/settings/rapidata_settings/" "" link RapidataSelections "../reference/rapidata/rapidata_client/selection/rapidata_selections/" "" @@ -74,17 +85,19 @@ classDiagram # Rapidata API -The Rapidata API builds on the [RapidataClient](reference/rapidata/rapidata_client/rapidata_client.md) class. This class is the entry point for all operations. The RapidataClient class has two main properties, order and validation, which are used to manage orders and validation sets respectively. +The Rapidata API builds on the [RapidataClient](reference/rapidata/rapidata_client/rapidata_client.md) class. This class is the entry point for all operations. You collect labels by creating a **job definition** with `job`, then assigning it to an **audience** — the job runs against that audience's annotators and produces results. + +### Job related classes -### Order related classes +[RapidataJobManager](reference/rapidata/rapidata_client/job/rapidata_job_manager.md) - accessible through the RapidataClient(rapi) under rapi.job. Creates job definitions and looks up jobs. -[RapidataOrderManger](reference/rapidata/rapidata_client/order/rapidata_order_manager.md) - accessible through the RapidataClient(rapi) under rapi.order +[RapidataAudienceManager](reference/rapidata/rapidata_client/audience/rapidata_audience_manager.md) - accessible through the RapidataClient(rapi) under rapi.audience. Manages annotator audiences and assigns job definitions to them. -[RapidataFilters](reference/rapidata/rapidata_client/filter/rapidata_filters.md) - accessible through the RapidataClient(rapi) under rapi.order +[RapidataFilters](reference/rapidata/rapidata_client/filter/rapidata_filters.md) - accessible through the RapidataClient(rapi) under rapi.job -[RapidataSettings](reference/rapidata/rapidata_client/settings/rapidata_settings.md) - accessible through the RapidataClient(rapi) under rapi.order +[RapidataSettings](reference/rapidata/rapidata_client/settings/rapidata_settings.md) - accessible through the RapidataClient(rapi) under rapi.job -[RapidataSelections](reference/rapidata/rapidata_client/selection/rapidata_selections.md) - accessible through the RapidataClient(rapi) under rapi.order +[RapidataSelections](reference/rapidata/rapidata_client/selection/rapidata_selections.md) - accessible through the RapidataClient(rapi) under rapi.job ### Validation related classes diff --git a/openapi/generate-schema.sh b/openapi/generate-schema.sh index a0bebb9ba8..81911d4926 100755 --- a/openapi/generate-schema.sh +++ b/openapi/generate-schema.sh @@ -54,12 +54,10 @@ asset audience order dataset -pipeline identity rapid campaign validation -workflow leaderboard flow translation @@ -104,19 +102,8 @@ npx -y @redocly/cli join ./${SCHEMA_DIR}/*.openapi.json -o ./${SCHEMA_DIR}/rapid # latter from any `required` list). This mirrors the endpoint filtering for # partly-deprecated surfaces like a single deprecated field on a model. # Note: the `walk` builtin requires jq >= 1.6. -# -# The $keep list below is the one exception to the rule: these endpoints are -# deprecated backend-side but the still-live order / QR-preview flow calls them -# directly, so dropping them would leave that flow uncompilable. Keep generating -# them until that flow migrates off them too. jq ' - ["/pipeline/{pipelineId}", "/workflow/{workflowId}/progress"] as $keep - | .paths |= with_entries( - .key as $path - | .value |= with_entries( - select((.value.deprecated != true) or ($keep | index($path))) - ) - ) + del(.paths[][] | select(.deprecated == true)) | walk( if type == "object" then ( if (.parameters | type) == "array" diff --git a/openapi/schemas/asset.openapi.json b/openapi/schemas/asset.openapi.json index 84f5f7ad46..69cb449bce 100644 --- a/openapi/schemas/asset.openapi.json +++ b/openapi/schemas/asset.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Asset API", "description": "The API for the Rapidata Asset service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/audience.openapi.json b/openapi/schemas/audience.openapi.json index 25d61a0525..b27ef428c6 100644 --- a/openapi/schemas/audience.openapi.json +++ b/openapi/schemas/audience.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Audience API", "description": "The API for the Rapidata Audience service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/campaign.openapi.json b/openapi/schemas/campaign.openapi.json index 3119c3b5a1..d60a67e63f 100644 --- a/openapi/schemas/campaign.openapi.json +++ b/openapi/schemas/campaign.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Campaign API", "description": "The API for the Rapidata Campaign service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/dataset.openapi.json b/openapi/schemas/dataset.openapi.json index a5c71bf1ce..29b472e421 100644 --- a/openapi/schemas/dataset.openapi.json +++ b/openapi/schemas/dataset.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Dataset API", "description": "The API for the Rapidata Dataset service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/flow.openapi.json b/openapi/schemas/flow.openapi.json index 02d5c30cea..1d714e3eaf 100644 --- a/openapi/schemas/flow.openapi.json +++ b/openapi/schemas/flow.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Flow API", "description": "The API for the Rapidata Flow service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/identity.openapi.json b/openapi/schemas/identity.openapi.json index 047f4ef070..ee08d700e4 100644 --- a/openapi/schemas/identity.openapi.json +++ b/openapi/schemas/identity.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Identity API", "description": "The API for the Rapidata Identity service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/leaderboard.openapi.json b/openapi/schemas/leaderboard.openapi.json index 5b6a70a49d..ca1f5c75b2 100644 --- a/openapi/schemas/leaderboard.openapi.json +++ b/openapi/schemas/leaderboard.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Leaderboard API", "description": "The API for the Rapidata Leaderboard service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/order.openapi.json b/openapi/schemas/order.openapi.json index 5aaeefde35..fa4e4bf8ac 100644 --- a/openapi/schemas/order.openapi.json +++ b/openapi/schemas/order.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Order API", "description": "The API for the Rapidata Order service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/payment.openapi.json b/openapi/schemas/payment.openapi.json index 68bc1c0c13..6d00984303 100644 --- a/openapi/schemas/payment.openapi.json +++ b/openapi/schemas/payment.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Payment API", "description": "The API for the Rapidata Payment service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/pipeline.openapi.json b/openapi/schemas/pipeline.openapi.json deleted file mode 100644 index 42c8468206..0000000000 --- a/openapi/schemas/pipeline.openapi.json +++ /dev/null @@ -1,1646 +0,0 @@ -{ - "openapi": "3.0.4", - "info": { - "title": "Rapidata Pipeline API", - "description": "The API for the Rapidata Pipeline service", - "version": "2026.08.20.1843-f4aff59" - }, - "servers": [ - { - "url": "https://api.rabbitdata.ch/" - } - ], - "paths": { - "/pipeline/{pipelineId}": { - "get": { - "tags": [ - "Pipeline" - ], - "summary": "Gets a pipeline by its id.", - "parameters": [ - { - "name": "pipelineId", - "in": "path", - "description": "The id of the pipeline to get.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetPipelineByIdEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true - } - }, - "/pipeline/preliminary-download/{preliminaryDownloadId}": { - "get": { - "tags": [ - "Pipeline" - ], - "summary": "Streams the preliminary download file when ready.", - "description": "Returns 202 while the download is still processing.", - "parameters": [ - { - "name": "preliminaryDownloadId", - "in": "path", - "description": "The id of the preliminary download to get.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "202": { - "description": "Accepted" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/pipeline/{pipelineId}/preliminary-download": { - "post": { - "tags": [ - "Pipeline" - ], - "summary": "Initiates a preliminary download of the pipeline.", - "parameters": [ - { - "name": "pipelineId", - "in": "path", - "description": "The id of the pipeline to initiate the download for.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Whether to email the caller when the download is ready.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StartPreliminaryDownloadEndpoint_Input" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StartPreliminaryDownloadEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - } - } - } - }, - "components": { - "schemas": { - "AttachCategoryRapidBlueprint_Category": { - "required": [ - "label", - "value" - ], - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "FeatureFlag": { - "required": [ - "key", - "value" - ], - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "FileType": { - "enum": [ - "Unknown", - "Image", - "Video", - "Audio" - ] - }, - "GetPipelineByIdEndpoint_Output": { - "required": [ - "artifacts", - "featureFlags" - ], - "type": "object", - "properties": { - "artifacts": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IArtifact" - } - } - ], - "description": "The artifacts attached to the pipeline, keyed by their role." - }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "The feature flags enabled for the pipeline." - } - } - }, - "IArtifact": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IArtifactCampaignArtifact" - }, - { - "$ref": "#/components/schemas/IArtifactDatasetArtifact" - }, - { - "$ref": "#/components/schemas/IArtifactFileArtifact" - }, - { - "$ref": "#/components/schemas/IArtifactWorkflowArtifact" - }, - { - "$ref": "#/components/schemas/IArtifactWorkflowConfigArtifact" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "CampaignArtifactModel": "#/components/schemas/IArtifactCampaignArtifact", - "DatasetArtifactModel": "#/components/schemas/IArtifactDatasetArtifact", - "FileArtifactModel": "#/components/schemas/IArtifactFileArtifact", - "WorkflowArtifactModel": "#/components/schemas/IArtifactWorkflowArtifact", - "WorkflowConfigArtifactModel": "#/components/schemas/IArtifactWorkflowConfigArtifact" - } - } - }, - "IArtifactCampaignArtifact": { - "required": [ - "campaignId", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CampaignArtifactModel" - ], - "type": "string" - }, - "campaignId": { - "type": "string" - }, - "identifier": { - "type": "string" - } - } - }, - "IArtifactDatasetArtifact": { - "required": [ - "datasetId", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "DatasetArtifactModel" - ], - "type": "string" - }, - "datasetId": { - "type": "string" - }, - "identifier": { - "type": "string" - } - } - }, - "IArtifactFileArtifact": { - "required": [ - "fileName", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FileArtifactModel" - ], - "type": "string" - }, - "fileName": { - "type": "string" - }, - "identifier": { - "type": "string" - } - } - }, - "IArtifactWorkflowArtifact": { - "required": [ - "workflowId", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "WorkflowArtifactModel" - ], - "type": "string" - }, - "workflowId": { - "type": "string" - }, - "identifier": { - "type": "string" - } - } - }, - "IArtifactWorkflowConfigArtifact": { - "required": [ - "workflowConfig", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "WorkflowConfigArtifactModel" - ], - "type": "string" - }, - "workflowConfig": { - "$ref": "#/components/schemas/IWorkflowConfig" - }, - "identifier": { - "type": "string" - } - } - }, - "IPipelineAsset": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineAssetPipelineFileAsset" - }, - { - "$ref": "#/components/schemas/IPipelineAssetPipelineMultiAsset" - }, - { - "$ref": "#/components/schemas/IPipelineAssetPipelineNullAsset" - }, - { - "$ref": "#/components/schemas/IPipelineAssetPipelineTextAsset" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FileAsset": "#/components/schemas/IPipelineAssetPipelineFileAsset", - "MultiAsset": "#/components/schemas/IPipelineAssetPipelineMultiAsset", - "NullAsset": "#/components/schemas/IPipelineAssetPipelineNullAsset", - "TextAsset": "#/components/schemas/IPipelineAssetPipelineTextAsset" - } - } - }, - "IPipelineAssetPipelineFileAsset": { - "required": [ - "fileName", - "metadata", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FileAsset" - ], - "type": "string" - }, - "fileName": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } - } - } - }, - "IPipelineAssetPipelineMultiAsset": { - "required": [ - "assets", - "metadata", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "MultiAsset" - ], - "type": "string" - }, - "assets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IPipelineAsset" - } - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } - } - } - }, - "IPipelineAssetPipelineNullAsset": { - "required": [ - "metadata", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NullAsset" - ], - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } - } - } - }, - "IPipelineAssetPipelineTextAsset": { - "required": [ - "text", - "metadata", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TextAsset" - ], - "type": "string" - }, - "text": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } - } - } - }, - "IPipelineMetadata": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineClassificationMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineCountMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineDurationMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineFileTypeMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineImageDimensionMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineLocationMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineOriginalFilenameMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineSourceUrlMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineStreamsMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineTextMetadata" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassificationMetadata": "#/components/schemas/IPipelineMetadataPipelineClassificationMetadata", - "CountMetadata": "#/components/schemas/IPipelineMetadataPipelineCountMetadata", - "DurationMetadata": "#/components/schemas/IPipelineMetadataPipelineDurationMetadata", - "FileTypeMetadata": "#/components/schemas/IPipelineMetadataPipelineFileTypeMetadata", - "ImageDimensionMetadata": "#/components/schemas/IPipelineMetadataPipelineImageDimensionMetadata", - "LocationMetadata": "#/components/schemas/IPipelineMetadataPipelineLocationMetadata", - "OriginalFilenameMetadata": "#/components/schemas/IPipelineMetadataPipelineOriginalFilenameMetadata", - "SourceUrlMetadata": "#/components/schemas/IPipelineMetadataPipelineSourceUrlMetadata", - "StreamsMetadata": "#/components/schemas/IPipelineMetadataPipelineStreamsMetadata", - "TextMetadata": "#/components/schemas/IPipelineMetadataPipelineTextMetadata" - } - } - }, - "IPipelineMetadataPipelineClassificationMetadata": { - "required": [ - "classification", - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassificationMetadata" - ], - "type": "string" - }, - "classification": { - "type": "string" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineCountMetadata": { - "required": [ - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CountMetadata" - ], - "type": "string" - }, - "count": { - "type": "integer", - "format": "int32" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineDurationMetadata": { - "required": [ - "duration", - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "DurationMetadata" - ], - "type": "string" - }, - "duration": { - "type": "string", - "format": "date-time" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineFileTypeMetadata": { - "required": [ - "fileType", - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FileTypeMetadata" - ], - "type": "string" - }, - "fileType": { - "$ref": "#/components/schemas/FileType" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineImageDimensionMetadata": { - "required": [ - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ImageDimensionMetadata" - ], - "type": "string" - }, - "height": { - "type": "integer", - "format": "int32" - }, - "width": { - "type": "integer", - "format": "int32" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineLocationMetadata": { - "required": [ - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocationMetadata" - ], - "type": "string" - }, - "x": { - "type": "number", - "format": "float" - }, - "y": { - "type": "number", - "format": "float" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineOriginalFilenameMetadata": { - "required": [ - "originalFilename", - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "OriginalFilenameMetadata" - ], - "type": "string" - }, - "originalFilename": { - "type": "string" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineSourceUrlMetadata": { - "required": [ - "url", - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "SourceUrlMetadata" - ], - "type": "string" - }, - "url": { - "type": "string" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineStreamsMetadata": { - "required": [ - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "StreamsMetadata" - ], - "type": "string" - }, - "hasAudio": { - "type": "boolean" - }, - "hasVideo": { - "type": "boolean" - }, - "hasSubtitles": { - "type": "boolean" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineTextMetadata": { - "required": [ - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TextMetadata" - ], - "type": "string" - }, - "text": { - "type": "string", - "nullable": true - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelinePairMakerConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig" - }, - { - "$ref": "#/components/schemas/IPipelinePairMakerConfigPipelineOnlinePairMakerConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FullPermutationPairMakerConfig": "#/components/schemas/IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig", - "OnlinePairMakerConfig": "#/components/schemas/IPipelinePairMakerConfigPipelineOnlinePairMakerConfig" - } - } - }, - "IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FullPermutationPairMakerConfig" - ], - "type": "string" - } - } - }, - "IPipelinePairMakerConfigPipelineOnlinePairMakerConfig": { - "required": [ - "randomMatchesRatio", - "totalComparisonBudget", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "OnlinePairMakerConfig" - ], - "type": "string" - }, - "randomMatchesRatio": { - "type": "number", - "format": "float" - }, - "totalComparisonBudget": { - "type": "integer", - "format": "int32" - } - } - }, - "IPipelineRankingConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineRankingConfigPipelineBradleyTerryRankingConfig" - }, - { - "$ref": "#/components/schemas/IPipelineRankingConfigPipelineEloRankingConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BradleyTerryRankingConfig": "#/components/schemas/IPipelineRankingConfigPipelineBradleyTerryRankingConfig", - "EloRankingConfig": "#/components/schemas/IPipelineRankingConfigPipelineEloRankingConfig" - } - } - }, - "IPipelineRankingConfigPipelineBradleyTerryRankingConfig": { - "required": [ - "startingScore", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BradleyTerryRankingConfig" - ], - "type": "string" - }, - "startingScore": { - "type": "integer", - "format": "int32" - } - } - }, - "IPipelineRankingConfigPipelineEloRankingConfig": { - "required": [ - "startingElo", - "kFactor", - "scalingFactor", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "EloRankingConfig" - ], - "type": "string" - }, - "startingElo": { - "type": "integer", - "format": "int32" - }, - "kFactor": { - "type": "integer", - "format": "int32" - }, - "scalingFactor": { - "type": "integer", - "format": "int32" - } - } - }, - "IRapidBlueprint": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRapidBlueprintAttachCategoryRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IRapidBlueprintBoundingBoxRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IRapidBlueprintCompareRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IRapidBlueprintFreeTextRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IRapidBlueprintLineRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IRapidBlueprintLocateRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IRapidBlueprintNamedEntityRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IRapidBlueprintPolygonRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IRapidBlueprintScrubRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IRapidBlueprintTranscriptionRapidBlueprint" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassifyBlueprint": "#/components/schemas/IRapidBlueprintAttachCategoryRapidBlueprint", - "BoundingBoxBlueprint": "#/components/schemas/IRapidBlueprintBoundingBoxRapidBlueprint", - "CompareBlueprint": "#/components/schemas/IRapidBlueprintCompareRapidBlueprint", - "FreeTextBlueprint": "#/components/schemas/IRapidBlueprintFreeTextRapidBlueprint", - "LineBlueprint": "#/components/schemas/IRapidBlueprintLineRapidBlueprint", - "LocateBlueprint": "#/components/schemas/IRapidBlueprintLocateRapidBlueprint", - "NamedEntityBlueprint": "#/components/schemas/IRapidBlueprintNamedEntityRapidBlueprint", - "PolygonBlueprint": "#/components/schemas/IRapidBlueprintPolygonRapidBlueprint", - "ScrubBlueprint": "#/components/schemas/IRapidBlueprintScrubRapidBlueprint", - "TranscriptionBlueprint": "#/components/schemas/IRapidBlueprintTranscriptionRapidBlueprint" - } - } - }, - "IRapidBlueprintAttachCategoryRapidBlueprint": { - "required": [ - "categories", - "title", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyBlueprint" - ], - "type": "string" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachCategoryRapidBlueprint_Category" - } - }, - "possibleCategories": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "title": { - "type": "string" - } - } - }, - "IRapidBlueprintBoundingBoxRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BoundingBoxBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidBlueprintCompareRapidBlueprint": { - "required": [ - "criteria", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CompareBlueprint" - ], - "type": "string" - }, - "criteria": { - "type": "string" - }, - "indexIdentifiers": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - } - }, - "IRapidBlueprintFreeTextRapidBlueprint": { - "required": [ - "question", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FreeTextBlueprint" - ], - "type": "string" - }, - "question": { - "type": "string" - }, - "shouldValidateResponse": { - "type": "boolean", - "nullable": true - }, - "validationSystemPrompt": { - "type": "string", - "nullable": true - } - } - }, - "IRapidBlueprintLineRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LineBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidBlueprintLocateRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocateBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidBlueprintNamedEntityRapidBlueprint": { - "required": [ - "target", - "classes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NamedEntityBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - }, - "classes": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IRapidBlueprintPolygonRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidBlueprintScrubRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScrubBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidBlueprintTranscriptionRapidBlueprint": { - "required": [ - "title", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TranscriptionBlueprint" - ], - "type": "string" - }, - "title": { - "type": "string" - } - } - }, - "IRefereeConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRefereeConfigBudgetRefereeConfig" - }, - { - "$ref": "#/components/schemas/IRefereeConfigNaiveRefereeConfig" - }, - { - "$ref": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig" - }, - { - "$ref": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig" - }, - { - "$ref": "#/components/schemas/IRefereeConfigQuorumRefereeConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BudgetRefereeConfig": "#/components/schemas/IRefereeConfigBudgetRefereeConfig", - "NaiveRefereeConfig": "#/components/schemas/IRefereeConfigNaiveRefereeConfig", - "NeverEndingRefereeConfig": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig", - "ProbabilisticAttachCategoryRefereeConfig": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig", - "QuorumRefereeConfig": "#/components/schemas/IRefereeConfigQuorumRefereeConfig" - } - } - }, - "IRefereeConfigBudgetRefereeConfig": { - "required": [ - "totalBudget", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BudgetRefereeConfig" - ], - "type": "string" - }, - "totalBudget": { - "type": "integer", - "format": "int32" - }, - "totalServeBudget": { - "type": "integer", - "format": "int32", - "nullable": true - } - } - }, - "IRefereeConfigNaiveRefereeConfig": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NaiveRefereeConfig" - ], - "type": "string" - }, - "responsesRequired": { - "type": "integer", - "format": "int32" - }, - "guessesRequired": { - "type": "integer", - "format": "int32", - "deprecated": true - } - } - }, - "IRefereeConfigNeverEndingRefereeConfig": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NeverEndingRefereeConfig" - ], - "type": "string" - } - } - }, - "IRefereeConfigProbabilisticAttachCategoryRefereeConfig": { - "required": [ - "threshold", - "maxVotes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ProbabilisticAttachCategoryRefereeConfig" - ], - "type": "string" - }, - "threshold": { - "type": "number", - "format": "double" - }, - "maxVotes": { - "type": "integer", - "format": "int32" - } - } - }, - "IRefereeConfigQuorumRefereeConfig": { - "required": [ - "maxVotes", - "threshold", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "QuorumRefereeConfig" - ], - "type": "string" - }, - "maxVotes": { - "type": "integer", - "format": "int32" - }, - "threshold": { - "type": "integer", - "format": "int32" - } - } - }, - "IWorkflowConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IWorkflowConfigEvaluationWorkflowConfig" - }, - { - "$ref": "#/components/schemas/IWorkflowConfigGroupedRankingWorkflowConfig" - }, - { - "$ref": "#/components/schemas/IWorkflowConfigRankingWorkflowConfig" - }, - { - "$ref": "#/components/schemas/IWorkflowConfigSimpleWorkflowConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "EvaluationWorkflowConfig": "#/components/schemas/IWorkflowConfigEvaluationWorkflowConfig", - "GroupedRankingWorkflowConfig": "#/components/schemas/IWorkflowConfigGroupedRankingWorkflowConfig", - "RankingWorkflowConfig": "#/components/schemas/IWorkflowConfigRankingWorkflowConfig", - "SimpleWorkflowConfig": "#/components/schemas/IWorkflowConfigSimpleWorkflowConfig" - } - } - }, - "IWorkflowConfigEvaluationWorkflowConfig": { - "required": [ - "validationSetId", - "referee", - "shouldAcceptIncorrect", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "EvaluationWorkflowConfig" - ], - "type": "string" - }, - "validationSetId": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "shouldAcceptIncorrect": { - "type": "boolean" - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - } - }, - "IWorkflowConfigGroupedRankingWorkflowConfig": { - "required": [ - "criteria", - "referee", - "targetCountryCodes", - "maxParallelism", - "pairMakerConfig", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "GroupedRankingWorkflowConfig" - ], - "type": "string" - }, - "criteria": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "targetCountryCodes": { - "type": "array", - "items": { - "type": "string" - } - }, - "contexts": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true, - "deprecated": true - }, - "contextAssets": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineAsset" - }, - "nullable": true, - "deprecated": true - }, - "maxParallelism": { - "type": "integer", - "format": "int32" - }, - "rankingConfig": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineRankingConfig" - } - ], - "nullable": true - }, - "eloConfig": { - "allOf": [ - { - "$ref": "#/components/schemas/PipelineEloRankingConfig" - } - ], - "deprecated": true - }, - "pairMakerConfig": { - "$ref": "#/components/schemas/IPipelinePairMakerConfig" - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - } - }, - "IWorkflowConfigRankingWorkflowConfig": { - "required": [ - "criteria", - "referee", - "pairMakerConfig", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "RankingWorkflowConfig" - ], - "type": "string" - }, - "criteria": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "context": { - "type": "string", - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineAsset" - } - ], - "nullable": true - }, - "rankingConfig": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineRankingConfig" - } - ], - "nullable": true - }, - "eloConfig": { - "allOf": [ - { - "$ref": "#/components/schemas/PipelineEloRankingConfig" - } - ], - "deprecated": true - }, - "pairMakerConfig": { - "$ref": "#/components/schemas/IPipelinePairMakerConfig" - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - } - }, - "IWorkflowConfigSimpleWorkflowConfig": { - "required": [ - "referee", - "blueprint", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "SimpleWorkflowConfig" - ], - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "blueprint": { - "$ref": "#/components/schemas/IRapidBlueprint" - }, - "batchSize": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - } - }, - "MetadataVisibilities": { - "type": "array", - "items": { - "enum": [ - "None", - "Users", - "Customers", - "Admins", - "Dashboard", - "All" - ], - "type": "string" - } - }, - "PipelineEloRankingConfig": { - "required": [ - "startingElo", - "kFactor", - "scalingFactor" - ], - "type": "object", - "properties": { - "startingElo": { - "type": "integer", - "format": "int32" - }, - "kFactor": { - "type": "integer", - "format": "int32" - }, - "scalingFactor": { - "type": "integer", - "format": "int32" - } - } - }, - "StartPreliminaryDownloadEndpoint_Input": { - "type": "object", - "properties": { - "sendEmail": { - "type": "boolean", - "description": "Whether to email the user when the download is ready." - } - } - }, - "StartPreliminaryDownloadEndpoint_Output": { - "required": [ - "downloadId" - ], - "type": "object", - "properties": { - "downloadId": { - "type": "string", - "description": "The id of the preliminary download that was initiated." - } - } - }, - "ValidationProblemDetails": { - "type": "object", - "properties": { - "type": { - "type": "string", - "nullable": true - }, - "title": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "instance": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "securitySchemes": { - "OpenIdConnect": { - "type": "openIdConnect", - "description": "OpenID Connect connection flow", - "openIdConnectUrl": "https://auth.rabbitdata.ch/.well-known/openid-configuration" - } - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] -} \ No newline at end of file diff --git a/openapi/schemas/rapid.openapi.json b/openapi/schemas/rapid.openapi.json index 38df506616..b0aed22959 100644 --- a/openapi/schemas/rapid.openapi.json +++ b/openapi/schemas/rapid.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Rapid API", "description": "The API for the Rapidata Rapid service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/rapidata.filtered.openapi.json b/openapi/schemas/rapidata.filtered.openapi.json index f666792c9c..5d7500d845 100644 --- a/openapi/schemas/rapidata.filtered.openapi.json +++ b/openapi/schemas/rapidata.filtered.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Asset API", "description": "The API for the Rapidata Asset service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { @@ -203,10 +203,6 @@ "name": "Payment", "x-displayName": "Payment" }, - { - "name": "Pipeline", - "x-displayName": "Pipeline" - }, { "name": "CustomerRapid", "x-displayName": "CustomerRapid" @@ -238,26 +234,6 @@ { "name": "ValidationSet", "x-displayName": "ValidationSet" - }, - { - "name": "Evaluation", - "x-displayName": "Evaluation" - }, - { - "name": "GroupedRanking", - "x-displayName": "GroupedRanking" - }, - { - "name": "Ranking", - "x-displayName": "Ranking" - }, - { - "name": "SimpleWorkflow", - "x-displayName": "SimpleWorkflow" - }, - { - "name": "Workflow", - "x-displayName": "Workflow" } ], "paths": { @@ -34364,30 +34340,30 @@ ] } }, - "/pipeline/{pipelineId}": { - "get": { + "/rapid/demographic": { + "post": { "tags": [ - "Pipeline" + "CustomerRapid" ], - "summary": "Gets a pipeline by its id.", - "parameters": [ - { - "name": "pipelineId", - "in": "path", - "description": "The id of the pipeline to get.", - "required": true, - "schema": { - "type": "string" + "summary": "Creates a new demographic rapid.", + "requestBody": { + "description": "The demographic rapid payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Input" + } } - } - ], + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPipelineByIdEndpoint_Output" + "$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Output" } } } @@ -34409,7 +34385,6 @@ "description": "Forbidden" } }, - "deprecated": true, "security": [ { "OpenIdConnect": [ @@ -34422,38 +34397,73 @@ ] } }, - "/pipeline/preliminary-download/{preliminaryDownloadId}": { - "get": { + "/rapid/{rapidId}": { + "delete": { "tags": [ - "Pipeline" + "CustomerRapid" ], - "summary": "Streams the preliminary download file when ready.", - "description": "Returns 202 while the download is still processing.", + "summary": "Deletes a rapid.", "parameters": [ { - "name": "preliminaryDownloadId", + "name": "rapidId", "in": "path", - "description": "The id of the preliminary download to get.", + "description": "The id of the rapid to delete.", "required": true, "schema": { "type": "string" } } ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthenticated" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "OpenIdConnect": [ + "openid", + "profile", + "email", + "offline_access" + ] + } + ] + } + }, + "/rapid/global-responses": { + "get": { + "tags": [ + "CustomerRapid" + ], + "summary": "Gets the most recent public responses across all customers.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output" } } } }, - "202": { - "description": "Accepted" - }, "400": { "description": "Bad Request", "content": { @@ -34483,41 +34493,30 @@ ] } }, - "/pipeline/{pipelineId}/preliminary-download": { - "post": { + "/rapid/{rapidId}/responses": { + "get": { "tags": [ - "Pipeline" + "CustomerRapid" ], - "summary": "Initiates a preliminary download of the pipeline.", + "summary": "Gets all responses for a given rapid.", "parameters": [ { - "name": "pipelineId", + "name": "rapidId", "in": "path", - "description": "The id of the pipeline to initiate the download for.", + "description": "The rapid to get the responses for.", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "description": "Whether to email the caller when the download is ready.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StartPreliminaryDownloadEndpoint_Input" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StartPreliminaryDownloadEndpoint_Output" + "$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output" } } } @@ -34551,524 +34550,314 @@ ] } }, - "/rapid/demographic": { - "post": { + "/rapids/flagged": { + "get": { "tags": [ "CustomerRapid" ], - "summary": "Creates a new demographic rapid.", - "requestBody": { - "description": "The demographic rapid payload.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Input" + "summary": "Queries all rapids that have been flagged.", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "The 1-based page index.", + "schema": { + "type": "integer" + }, + "x-parameter-group": "page" + }, + { + "name": "page_size", + "in": "query", + "description": "The number of items per page.", + "schema": { + "type": "integer" + }, + "x-parameter-group": "page" + }, + { + "name": "sort", + "in": "query", + "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", + "schema": { + "type": "array", + "items": { + "enum": [ + "id", + "-id", + "completed_at", + "-completed_at" + ], + "type": "string" } - } + }, + "x-parameter-group": "sort" }, - "required": true - }, + { + "name": "id", + "in": "query", + "description": "Filter by id.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "correlation_id", + "in": "query", + "description": "Filter by correlation_id.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "owner_id", + "in": "query", + "description": "Filter by owner_id.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "key", + "in": "query", + "description": "Filter by key.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "completed_at", + "in": "query", + "description": "Filter by completed_at.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "logic", + "in": "query", + "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", + "schema": { + "enum": [ + "and", + "or" + ], + "type": "string" + } + } + ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/rapid/{rapidId}": { - "delete": { - "tags": [ - "CustomerRapid" - ], - "summary": "Deletes a rapid.", - "parameters": [ - { - "name": "rapidId", - "in": "path", - "description": "The id of the rapid to delete.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/rapid/global-responses": { - "get": { - "tags": [ - "CustomerRapid" - ], - "summary": "Gets the most recent public responses across all customers.", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/rapid/{rapidId}/responses": { - "get": { - "tags": [ - "CustomerRapid" - ], - "summary": "Gets all responses for a given rapid.", - "parameters": [ - { - "name": "rapidId", - "in": "path", - "description": "The rapid to get the responses for.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/rapids/flagged": { - "get": { - "tags": [ - "CustomerRapid" - ], - "summary": "Queries all rapids that have been flagged.", - "parameters": [ - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "id", - "-id", - "completed_at", - "-completed_at" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - }, - { - "name": "id", - "in": "query", - "description": "Filter by id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "correlation_id", - "in": "query", - "description": "Filter by correlation_id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "owner_id", - "in": "query", - "description": "Filter by owner_id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "key", - "in": "query", - "description": "Filter by key.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "completed_at", - "in": "query", - "description": "Filter by completed_at.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "logic", - "in": "query", - "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", - "schema": { - "enum": [ - "and", - "or" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_PagedResultOfOutput" + "$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_PagedResultOfOutput" } } } @@ -39349,414 +39138,6 @@ } ] } - }, - "/workflow/evaluation/{workflowId}/results": {}, - "/workflow/grouped-ranking/{workflowId}/results": {}, - "/workflow/compare/{workflowId}/results": {}, - "/workflow/simple/{workflowId}/results": {}, - "/workflow/{workflowId}": { - "delete": { - "tags": [ - "Workflow" - ], - "summary": "Deletes a workflow by its id.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to delete.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflow/{workflowId}/compare-ab-summary": {}, - "/workflow/{workflowId}/progress": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Gets the progress of a workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the progress for.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetWorkflowProgressEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflow/{workflowId}/responses": {}, - "/workflows": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Queries workflows based on the provided filter, page, and sort criteria.", - "parameters": [ - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "name", - "-name", - "state", - "-state", - "created_at", - "-created_at" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - }, - { - "name": "id", - "in": "query", - "description": "Filter by id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "name", - "in": "query", - "description": "Filter by name.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "state", - "in": "query", - "description": "Filter by state.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "owner_mail", - "in": "query", - "description": "Filter by owner_mail.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "logic", - "in": "query", - "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", - "schema": { - "enum": [ - "and", - "or" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QueryWorkflowsEndpoint_PagedResultOfOutput" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } } }, "components": { @@ -62295,4222 +61676,1783 @@ "Revoked" ] }, - "GetPipelineByIdEndpoint_Output": { + "AddUserResponseEndpoint_Input": { "required": [ - "artifacts", - "featureFlags" + "sessionIndex", + "result" ], "type": "object", "properties": { - "artifacts": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IArtifact" - } - } - ], - "description": "The artifacts attached to the pipeline, keyed by their role." + "sessionIndex": { + "type": "integer", + "description": "The index of the session when the result was submitted.", + "format": "int32" }, - "featureFlags": { + "result": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } + "$ref": "#/components/schemas/IRapidResult" } ], - "description": "The feature flags enabled for the pipeline." + "description": "The result submitted by the user." } } }, - "IArtifact": { + "AddUserResponseEndpoint_Output": { "required": [ - "_t" + "isAccepted", + "userScore" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IArtifactCampaignArtifact" + "properties": { + "isAccepted": { + "type": "boolean", + "description": "Whether the response was accepted." }, - { - "$ref": "#/components/schemas/IArtifactDatasetArtifact" + "validationTruth": { + "allOf": [ + { + "$ref": "#/components/schemas/IValidationTruth" + } + ], + "description": "The validation truth applied to the response, if any." }, - { - "$ref": "#/components/schemas/IArtifactFileArtifact" + "explanation": { + "allOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "description": "An optional translated explanation for the user." }, - { - "$ref": "#/components/schemas/IArtifactWorkflowArtifact" + "userScore": { + "type": "number", + "description": "The user's score after processing this response.", + "format": "double" }, - { - "$ref": "#/components/schemas/IArtifactWorkflowConfigArtifact" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "CampaignArtifactModel": "#/components/schemas/IArtifactCampaignArtifact", - "DatasetArtifactModel": "#/components/schemas/IArtifactDatasetArtifact", - "FileArtifactModel": "#/components/schemas/IArtifactFileArtifact", - "WorkflowArtifactModel": "#/components/schemas/IArtifactWorkflowArtifact", - "WorkflowConfigArtifactModel": "#/components/schemas/IArtifactWorkflowConfigArtifact" + "nextRapid": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapid" + } + ], + "description": "The next rapid to solve when the session streams its rapids and continues.\n Null when there is nothing further to solve." } } }, - "IArtifactCampaignArtifact": { + "AttachCategoryRapid_Category": { "required": [ - "campaignId", - "identifier", - "_t" + "value", + "label" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "CampaignArtifactModel" - ], - "type": "string" - }, - "campaignId": { + "value": { "type": "string" }, - "identifier": { - "type": "string" + "label": { + "$ref": "#/components/schemas/TranslatedString" } } }, - "IArtifactDatasetArtifact": { + "ClassifyPayload": { "required": [ - "datasetId", - "identifier", - "_t" + "categories", + "title" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "DatasetArtifactModel" - ], - "type": "string" - }, - "datasetId": { - "type": "string" + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ClassifyPayload_Category" + } }, - "identifier": { + "title": { "type": "string" } } }, - "IArtifactFileArtifact": { + "CreateDemographicRapidEndpoint_Input": { "required": [ - "fileName", - "identifier", - "_t" + "key", + "payload" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FileArtifactModel" + "key": { + "type": "string", + "description": "The identifier of the demographic classification." + }, + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/ClassifyPayload" + } ], - "type": "string" + "description": "The payload for the classification." }, - "fileName": { - "type": "string" + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "Optional feature flags to apply to the rapid." }, - "identifier": { - "type": "string" + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "An optional asset to associate with the rapid." + }, + "context": { + "type": "string", + "description": "An optional text context to show to the user.", + "nullable": true + }, + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "An optional asset to use as context to show to the user." } } }, - "IArtifactWorkflowArtifact": { + "CreateDemographicRapidEndpoint_Output": { "required": [ - "workflowId", - "identifier", - "_t" + "rapidId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "WorkflowArtifactModel" - ], - "type": "string" - }, - "workflowId": { - "type": "string" - }, - "identifier": { - "type": "string" + "rapidId": { + "type": "string", + "description": "The id of the created rapid." } } }, - "IArtifactWorkflowConfigArtifact": { + "CreateGlobalTextEndpoint_Input": { "required": [ - "workflowConfig", - "identifier", - "_t" + "key", + "englishText" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "WorkflowConfigArtifactModel" - ], - "type": "string" - }, - "workflowConfig": { - "$ref": "#/components/schemas/IWorkflowConfig" + "key": { + "type": "string", + "description": "The human-readable key used to look up the text from translations." }, - "identifier": { - "type": "string" + "englishText": { + "type": "string", + "description": "The English source text that all translations derive from." } } }, - "IPipelineAsset": { + "CreateGlobalTextEndpoint_Output": { "required": [ - "_t" + "globalTextId" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineAssetPipelineFileAsset" - }, - { - "$ref": "#/components/schemas/IPipelineAssetPipelineMultiAsset" - }, - { - "$ref": "#/components/schemas/IPipelineAssetPipelineNullAsset" - }, - { - "$ref": "#/components/schemas/IPipelineAssetPipelineTextAsset" + "properties": { + "globalTextId": { + "type": "string", + "description": "The unique identifier of the created global text entry." } + } + }, + "CreateValidationFeedbackEndpoint_Input": { + "required": [ + "feedback" ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FileAsset": "#/components/schemas/IPipelineAssetPipelineFileAsset", - "MultiAsset": "#/components/schemas/IPipelineAssetPipelineMultiAsset", - "NullAsset": "#/components/schemas/IPipelineAssetPipelineNullAsset", - "TextAsset": "#/components/schemas/IPipelineAssetPipelineTextAsset" + "type": "object", + "properties": { + "feedback": { + "type": "string", + "description": "The feedback text." } } }, - "IPipelineAssetPipelineFileAsset": { + "GetAllGlobalTextsEndpoint_Output": { "required": [ - "fileName", - "metadata", - "_t" + "globalTexts" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FileAsset" + "globalTexts": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetAllGlobalTextsEndpoint_Output_Item" + } + } ], - "type": "string" - }, - "fileName": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } + "description": "The list of global text entries." } } }, - "IPipelineAssetPipelineMultiAsset": { + "GetAllGlobalTextsEndpoint_Output_Item": { "required": [ - "assets", - "metadata", - "_t" + "id", + "key", + "englishText" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "MultiAsset" - ], + "id": { "type": "string" }, - "assets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IPipelineAsset" - } + "key": { + "type": "string" }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } + "englishText": { + "type": "string" } } }, - "IPipelineAssetPipelineNullAsset": { + "GetGlobalResponsesEndpoint_Output": { "required": [ - "metadata", - "_t" + "responses" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NullAsset" + "responses": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output_Response" + } + } ], - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } + "description": "The most recent public responses." } } }, - "IPipelineAssetPipelineTextAsset": { + "GetGlobalResponsesEndpoint_Output_Response": { "required": [ - "text", - "metadata", - "_t" + "id", + "userId", + "country" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "TextAsset" - ], + "id": { "type": "string" }, - "text": { + "userId": { "type": "string" }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } + "country": { + "type": "string" + }, + "age": { + "type": "string", + "nullable": true + }, + "occupation": { + "type": "string", + "nullable": true + }, + "gender": { + "type": "string", + "nullable": true } } }, - "IPipelineMetadata": { + "GetRapidNavigationEndpoint_Card": { "required": [ - "_t" + "rapidId", + "asset", + "state", + "payload", + "responses", + "totalResponseCount" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineClassificationMetadata" + "properties": { + "rapidId": { + "type": "string" }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineCountMetadata" + "asset": { + "$ref": "#/components/schemas/IAsset" }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineDurationMetadata" + "state": { + "$ref": "#/components/schemas/RapidState" }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineFileTypeMetadata" + "payload": { + "$ref": "#/components/schemas/IRapidPayload" }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineImageDimensionMetadata" + "responses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Card_Response" + } }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineLocationMetadata" + "totalResponseCount": { + "type": "integer", + "format": "int64" }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineOriginalFilenameMetadata" + "context": { + "type": "string", + "nullable": true }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineSourceUrlMetadata" + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineStreamsMetadata" + "decisiveness": { + "type": "number", + "format": "double", + "nullable": true }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineTextMetadata" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassificationMetadata": "#/components/schemas/IPipelineMetadataPipelineClassificationMetadata", - "CountMetadata": "#/components/schemas/IPipelineMetadataPipelineCountMetadata", - "DurationMetadata": "#/components/schemas/IPipelineMetadataPipelineDurationMetadata", - "FileTypeMetadata": "#/components/schemas/IPipelineMetadataPipelineFileTypeMetadata", - "ImageDimensionMetadata": "#/components/schemas/IPipelineMetadataPipelineImageDimensionMetadata", - "LocationMetadata": "#/components/schemas/IPipelineMetadataPipelineLocationMetadata", - "OriginalFilenameMetadata": "#/components/schemas/IPipelineMetadataPipelineOriginalFilenameMetadata", - "SourceUrlMetadata": "#/components/schemas/IPipelineMetadataPipelineSourceUrlMetadata", - "StreamsMetadata": "#/components/schemas/IPipelineMetadataPipelineStreamsMetadata", - "TextMetadata": "#/components/schemas/IPipelineMetadataPipelineTextMetadata" + "aggregation": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IResponseAggregation" + } + ], + "nullable": true } } }, - "IPipelineMetadataPipelineClassificationMetadata": { + "GetRapidNavigationEndpoint_Card_Response": { "required": [ - "classification", - "visibilities", - "_t" + "id", + "userId", + "country", + "language", + "age", + "gender", + "occupation", + "demographicInformation", + "result", + "userScore", + "userScores" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ClassificationMetadata" - ], + "id": { "type": "string" }, - "classification": { + "userId": { "type": "string" }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineCountMetadata": { - "required": [ - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CountMetadata" - ], + "country": { "type": "string" }, - "count": { - "type": "integer", - "format": "int32" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineDurationMetadata": { - "required": [ - "duration", - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "DurationMetadata" - ], + "language": { "type": "string" }, - "duration": { + "age": { "type": "string", - "format": "date-time" + "nullable": true }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "gender": { + "type": "string", + "nullable": true + }, + "occupation": { + "type": "string", + "nullable": true + }, + "demographicInformation": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "result": { + "$ref": "#/components/schemas/IRapidResult" + }, + "userScore": { + "type": "number", + "format": "double" + }, + "userScores": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double" + } } } }, - "IPipelineMetadataPipelineFileTypeMetadata": { + "GetRapidNavigationEndpoint_Item": { "required": [ - "fileType", - "visibilities", - "_t" + "rapidId", + "asset", + "state" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FileTypeMetadata" - ], + "rapidId": { "type": "string" }, - "fileType": { - "$ref": "#/components/schemas/FileType" + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "state": { + "$ref": "#/components/schemas/RapidState" } } }, - "IPipelineMetadataPipelineImageDimensionMetadata": { + "GetRapidNavigationEndpoint_Output": { "required": [ - "visibilities", - "_t" + "current", + "previous", + "next", + "index", + "total" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ImageDimensionMetadata" + "current": { + "allOf": [ + { + "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Card" + } ], - "type": "string" + "description": "The anchor rapid, carrying the same fields a results-grid card renders." }, - "height": { - "type": "integer", - "format": "int32" + "previous": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Item" + } + } + ], + "description": "The rapids preceding the anchor in grid order, at most window entries,\n ordered ascending with the neighbour adjacent to the anchor last." }, - "width": { + "next": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Item" + } + } + ], + "description": "The rapids following the anchor in grid order, at most window entries,\n in ascending order." + }, + "index": { "type": "integer", - "format": "int32" + "description": "The 1-based position of the anchor within the filtered slice.", + "format": "int64" }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "total": { + "type": "integer", + "description": "The total number of rapids in the filtered slice.", + "format": "int64" } } }, - "IPipelineMetadataPipelineLocationMetadata": { + "GetResponsesForRapidEndpoint_Output": { "required": [ - "visibilities", - "_t" + "rapidId", + "asset", + "responses", + "state" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LocationMetadata" - ], - "type": "string" + "rapidId": { + "type": "string", + "description": "The id of the rapid." }, - "x": { - "type": "number", - "format": "float" + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The asset of the rapid." }, - "y": { - "type": "number", - "format": "float" + "responses": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output_Response" + } + } + ], + "description": "The list of responses for the rapid." }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/RapidState" + } + ], + "description": "The state of the rapid." } } }, - "IPipelineMetadataPipelineOriginalFilenameMetadata": { + "GetResponsesForRapidEndpoint_Output_Response": { "required": [ - "originalFilename", - "visibilities", - "_t" + "id", + "userId", + "country", + "age", + "gender", + "occupation", + "demographicInformation", + "result", + "userScore", + "userScores" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "OriginalFilenameMetadata" - ], + "id": { "type": "string" }, - "originalFilename": { + "userId": { "type": "string" }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineSourceUrlMetadata": { - "required": [ - "url", - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "SourceUrlMetadata" - ], + "country": { "type": "string" }, - "url": { - "type": "string" + "age": { + "type": "string", + "nullable": true }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineStreamsMetadata": { - "required": [ - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "StreamsMetadata" - ], - "type": "string" + "gender": { + "type": "string", + "nullable": true }, - "hasAudio": { - "type": "boolean" + "occupation": { + "type": "string", + "nullable": true }, - "hasVideo": { - "type": "boolean" + "demographicInformation": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "hasSubtitles": { - "type": "boolean" + "result": { + "$ref": "#/components/schemas/IRapidResult" }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "userScore": { + "type": "number", + "format": "double" + }, + "userScores": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double" + } } } }, - "IPipelineMetadataPipelineTextMetadata": { - "required": [ - "visibilities", - "_t" - ], + "InspectReportEndpoint_Output": { + "type": "object", "properties": { - "_t": { - "enum": [ - "TextMetadata" - ], - "type": "string" - }, - "text": { + "dump": { "type": "string", + "description": "The captured dump, if any.", "nullable": true - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" } } }, - "IPipelinePairMakerConfig": { + "IRapid": { "required": [ "_t" ], "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig" + "$ref": "#/components/schemas/IRapidAttachCategoryRapid" + }, + { + "$ref": "#/components/schemas/IRapidBoundingBoxRapid" + }, + { + "$ref": "#/components/schemas/IRapidCompareRapid" + }, + { + "$ref": "#/components/schemas/IRapidFreeTextRapid" + }, + { + "$ref": "#/components/schemas/IRapidLineRapid" + }, + { + "$ref": "#/components/schemas/IRapidLocateRapid" + }, + { + "$ref": "#/components/schemas/IRapidNamedEntityRapid" + }, + { + "$ref": "#/components/schemas/IRapidPolygonRapid" + }, + { + "$ref": "#/components/schemas/IRapidScrubRapid" }, { - "$ref": "#/components/schemas/IPipelinePairMakerConfigPipelineOnlinePairMakerConfig" + "$ref": "#/components/schemas/IRapidTranscriptionRapid" } ], "discriminator": { "propertyName": "_t", "mapping": { - "FullPermutationPairMakerConfig": "#/components/schemas/IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig", - "OnlinePairMakerConfig": "#/components/schemas/IPipelinePairMakerConfigPipelineOnlinePairMakerConfig" + "AttachCategoryRapidModel": "#/components/schemas/IRapidAttachCategoryRapid", + "BoundingBoxRapidModel": "#/components/schemas/IRapidBoundingBoxRapid", + "CompareRapidModel": "#/components/schemas/IRapidCompareRapid", + "FreeTextRapidModel": "#/components/schemas/IRapidFreeTextRapid", + "LineRapidModel": "#/components/schemas/IRapidLineRapid", + "LocateRapidModel": "#/components/schemas/IRapidLocateRapid", + "NamedEntityRapidModel": "#/components/schemas/IRapidNamedEntityRapid", + "PolygonRapidModel": "#/components/schemas/IRapidPolygonRapid", + "ScrubRapidModel": "#/components/schemas/IRapidScrubRapid", + "TranscriptionRapidModel": "#/components/schemas/IRapidTranscriptionRapid" } } }, - "IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig": { + "IRapidAttachCategoryRapid": { "required": [ + "categories", + "title", + "asset", + "featureFlags", + "id", "_t" ], "properties": { "_t": { "enum": [ - "FullPermutationPairMakerConfig" + "AttachCategoryRapidModel" + ], + "type": "string" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttachCategoryRapid_Category" + } + }, + "title": { + "$ref": "#/components/schemas/TranslatedString" + }, + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } ], + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true + }, + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + }, + "id": { "type": "string" } } }, - "IPipelinePairMakerConfigPipelineOnlinePairMakerConfig": { + "IRapidBoundingBoxRapid": { "required": [ - "randomMatchesRatio", - "totalComparisonBudget", + "target", + "asset", + "featureFlags", + "id", "_t" ], "properties": { "_t": { "enum": [ - "OnlinePairMakerConfig" + "BoundingBoxRapidModel" ], "type": "string" }, - "randomMatchesRatio": { - "type": "number", - "format": "float" + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "totalComparisonBudget": { - "type": "integer", - "format": "int32" - } - } - }, - "IPipelineRankingConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineRankingConfigPipelineBradleyTerryRankingConfig" + "asset": { + "$ref": "#/components/schemas/IAsset" }, - { - "$ref": "#/components/schemas/IPipelineRankingConfigPipelineEloRankingConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BradleyTerryRankingConfig": "#/components/schemas/IPipelineRankingConfigPipelineBradleyTerryRankingConfig", - "EloRankingConfig": "#/components/schemas/IPipelineRankingConfigPipelineEloRankingConfig" + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true + }, + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + }, + "id": { + "type": "string" } } }, - "IPipelineRankingConfigPipelineBradleyTerryRankingConfig": { + "IRapidCompareRapid": { "required": [ - "startingScore", + "criteria", + "asset", + "featureFlags", + "id", "_t" ], "properties": { "_t": { "enum": [ - "BradleyTerryRankingConfig" + "CompareRapidModel" ], "type": "string" }, - "startingScore": { - "type": "integer", - "format": "int32" + "criteria": { + "$ref": "#/components/schemas/TranslatedString" + }, + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true + }, + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + }, + "id": { + "type": "string" } } }, - "IPipelineRankingConfigPipelineEloRankingConfig": { + "IRapidFreeTextRapid": { "required": [ - "startingElo", - "kFactor", - "scalingFactor", + "question", + "asset", + "featureFlags", + "id", "_t" ], "properties": { "_t": { "enum": [ - "EloRankingConfig" + "FreeTextRapidModel" ], "type": "string" }, - "startingElo": { - "type": "integer", - "format": "int32" - }, - "kFactor": { - "type": "integer", - "format": "int32" + "question": { + "$ref": "#/components/schemas/TranslatedString" }, - "scalingFactor": { - "type": "integer", - "format": "int32" - } - } - }, - "IRefereeConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRefereeConfigBudgetRefereeConfig" + "asset": { + "$ref": "#/components/schemas/IAsset" }, - { - "$ref": "#/components/schemas/IRefereeConfigNaiveRefereeConfig" + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "nullable": true }, - { - "$ref": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig" + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true }, - { - "$ref": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig" + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } }, - { - "$ref": "#/components/schemas/IRefereeConfigQuorumRefereeConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BudgetRefereeConfig": "#/components/schemas/IRefereeConfigBudgetRefereeConfig", - "NaiveRefereeConfig": "#/components/schemas/IRefereeConfigNaiveRefereeConfig", - "NeverEndingRefereeConfig": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig", - "ProbabilisticAttachCategoryRefereeConfig": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig", - "QuorumRefereeConfig": "#/components/schemas/IRefereeConfigQuorumRefereeConfig" + "id": { + "type": "string" } } }, - "IRefereeConfigBudgetRefereeConfig": { + "IRapidLineRapid": { "required": [ - "totalBudget", + "target", + "asset", + "featureFlags", + "id", "_t" ], "properties": { "_t": { "enum": [ - "BudgetRefereeConfig" + "LineRapidModel" ], "type": "string" }, - "totalBudget": { - "type": "integer", - "format": "int32" + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "totalServeBudget": { - "type": "integer", - "format": "int32", + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true + }, + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + }, + "id": { + "type": "string" } } }, - "IRefereeConfigNaiveRefereeConfig": { + "IRapidLocateRapid": { "required": [ + "target", + "asset", + "featureFlags", + "id", "_t" ], "properties": { "_t": { "enum": [ - "NaiveRefereeConfig" + "LocateRapidModel" ], "type": "string" }, - "responsesRequired": { - "type": "integer", - "format": "int32" - } - } - }, - "IRefereeConfigNeverEndingRefereeConfig": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NeverEndingRefereeConfig" + "target": { + "$ref": "#/components/schemas/TranslatedString" + }, + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } ], - "type": "string" - } - } - }, - "IRefereeConfigProbabilisticAttachCategoryRefereeConfig": { - "required": [ - "threshold", - "maxVotes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ProbabilisticAttachCategoryRefereeConfig" + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } ], - "type": "string" + "nullable": true }, - "threshold": { - "type": "number", - "format": "double" + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } }, - "maxVotes": { - "type": "integer", - "format": "int32" + "id": { + "type": "string" } } }, - "IRefereeConfigQuorumRefereeConfig": { + "IRapidNamedEntityRapid": { "required": [ - "maxVotes", - "threshold", + "target", + "classes", + "asset", + "featureFlags", + "id", "_t" ], "properties": { "_t": { "enum": [ - "QuorumRefereeConfig" + "NamedEntityRapidModel" ], "type": "string" }, - "maxVotes": { - "type": "integer", - "format": "int32" + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "threshold": { - "type": "integer", - "format": "int32" - } - } - }, - "IWorkflowConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IWorkflowConfigEvaluationWorkflowConfig" + "classes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslatedString" + } }, - { - "$ref": "#/components/schemas/IWorkflowConfigGroupedRankingWorkflowConfig" + "asset": { + "$ref": "#/components/schemas/IAsset" }, - { - "$ref": "#/components/schemas/IWorkflowConfigRankingWorkflowConfig" + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "nullable": true }, - { - "$ref": "#/components/schemas/IWorkflowConfigSimpleWorkflowConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "EvaluationWorkflowConfig": "#/components/schemas/IWorkflowConfigEvaluationWorkflowConfig", - "GroupedRankingWorkflowConfig": "#/components/schemas/IWorkflowConfigGroupedRankingWorkflowConfig", - "RankingWorkflowConfig": "#/components/schemas/IWorkflowConfigRankingWorkflowConfig", - "SimpleWorkflowConfig": "#/components/schemas/IWorkflowConfigSimpleWorkflowConfig" + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true + }, + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + }, + "id": { + "type": "string" } } }, - "IWorkflowConfigEvaluationWorkflowConfig": { + "IRapidPolygonRapid": { "required": [ - "validationSetId", - "referee", - "shouldAcceptIncorrect", + "target", + "asset", + "featureFlags", + "id", "_t" ], "properties": { "_t": { "enum": [ - "EvaluationWorkflowConfig" + "PolygonRapidModel" ], "type": "string" }, - "validationSetId": { - "type": "string" + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "shouldAcceptIncorrect": { - "type": "boolean" + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true }, "featureFlags": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true + } + }, + "id": { + "type": "string" } } }, - "IWorkflowConfigGroupedRankingWorkflowConfig": { + "IRapidScrubRapid": { "required": [ - "criteria", - "referee", - "targetCountryCodes", - "maxParallelism", - "pairMakerConfig", + "target", + "id", + "featureFlags", + "asset", "_t" ], "properties": { "_t": { "enum": [ - "GroupedRankingWorkflowConfig" + "ScrubRapidModel" ], "type": "string" }, - "criteria": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "targetCountryCodes": { - "type": "array", - "items": { - "type": "string" - } + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "maxParallelism": { - "type": "integer", - "format": "int32" + "id": { + "type": "string" }, - "rankingConfig": { + "context": { "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/IPipelineRankingConfig" + "$ref": "#/components/schemas/TranslatedString" } ], "nullable": true }, - "pairMakerConfig": { - "$ref": "#/components/schemas/IPipelinePairMakerConfig" + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true }, "featureFlags": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true + } + }, + "asset": { + "$ref": "#/components/schemas/IAsset" } } }, - "IWorkflowConfigRankingWorkflowConfig": { + "IRapidTranscriptionRapid": { "required": [ - "criteria", - "referee", - "pairMakerConfig", + "transcription", + "title", + "asset", + "featureFlags", + "id", "_t" ], "properties": { "_t": { "enum": [ - "RankingWorkflowConfig" + "TranscriptionRapidModel" ], "type": "string" }, - "criteria": { - "type": "string" + "transcription": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranscriptionRapid_TranscriptionWord" + } }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" + "title": { + "$ref": "#/components/schemas/TranslatedString" }, - "context": { - "type": "string", - "nullable": true + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "contextAsset": { + "context": { "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/IPipelineAsset" + "$ref": "#/components/schemas/TranslatedString" } ], "nullable": true }, - "rankingConfig": { + "contextAsset": { "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/IPipelineRankingConfig" + "$ref": "#/components/schemas/IAsset" } ], "nullable": true }, - "pairMakerConfig": { - "$ref": "#/components/schemas/IPipelinePairMakerConfig" - }, "featureFlags": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true + } + }, + "id": { + "type": "string" } } }, - "IWorkflowConfigSimpleWorkflowConfig": { + "IRefereeInfo": { + "required": [ + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IRefereeInfoNaiveRefereeInfo" + }, + { + "$ref": "#/components/schemas/IRefereeInfoNeverEndingRefereeInfo" + }, + { + "$ref": "#/components/schemas/IRefereeInfoProbabilisticAttachCategoryRefereeInfo" + }, + { + "$ref": "#/components/schemas/IRefereeInfoQuorumRefereeInfo" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "NaiveRefereeInfo": "#/components/schemas/IRefereeInfoNaiveRefereeInfo", + "NeverEndingRefereeInfo": "#/components/schemas/IRefereeInfoNeverEndingRefereeInfo", + "ProbabilisticAttachCategoryRefereeInfo": "#/components/schemas/IRefereeInfoProbabilisticAttachCategoryRefereeInfo", + "QuorumRefereeInfo": "#/components/schemas/IRefereeInfoQuorumRefereeInfo" + } + } + }, + "IRefereeInfoNaiveRefereeInfo": { "required": [ - "referee", - "blueprint", "_t" ], "properties": { "_t": { "enum": [ - "SimpleWorkflowConfig" + "NaiveRefereeInfo" ], "type": "string" }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "blueprint": { - "$ref": "#/components/schemas/IRapidBlueprint" + "responseAmountThreshold": { + "type": "integer", + "format": "int32" }, - "batchSize": { + "serveThreshold": { "type": "integer", "format": "int32", "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true } } }, - "PipelineEloRankingConfig": { + "IRefereeInfoNeverEndingRefereeInfo": { "required": [ - "startingElo", - "kFactor", - "scalingFactor" + "_t" ], - "type": "object", "properties": { - "startingElo": { + "_t": { + "enum": [ + "NeverEndingRefereeInfo" + ], + "type": "string" + } + } + }, + "IRefereeInfoProbabilisticAttachCategoryRefereeInfo": { + "required": [ + "threshold", + "maxVotes", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "ProbabilisticAttachCategoryRefereeInfo" + ], + "type": "string" + }, + "threshold": { + "type": "number", + "format": "double" + }, + "maxVotes": { "type": "integer", "format": "int32" + } + } + }, + "IRefereeInfoQuorumRefereeInfo": { + "required": [ + "maxVotes", + "threshold", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "QuorumRefereeInfo" + ], + "type": "string" }, - "kFactor": { + "maxVotes": { "type": "integer", "format": "int32" }, - "scalingFactor": { + "threshold": { "type": "integer", "format": "int32" } } }, - "StartPreliminaryDownloadEndpoint_Input": { + "IsRapidBagValidEndpoint_Output": { + "required": [ + "isValid" + ], "type": "object", "properties": { - "sendEmail": { + "isValid": { "type": "boolean", - "description": "Whether to email the user when the download is ready." + "description": "Whether the rapid bag is valid." } } }, - "StartPreliminaryDownloadEndpoint_Output": { + "IValidationTruth": { "required": [ - "downloadId" + "_t" ], "type": "object", - "properties": { - "downloadId": { - "type": "string", - "description": "The id of the preliminary download that was initiated." + "oneOf": [ + { + "$ref": "#/components/schemas/IValidationTruthAttachCategoryTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthBoundingBoxTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthClassifyTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthCompareTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthEmptyValidationTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthLineTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthLocateBoxTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthMultiCompareTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthNamedEntityTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthPolygonTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthScrubTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthSkipTruth" + }, + { + "$ref": "#/components/schemas/IValidationTruthTranscriptionTruth" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AttachCategoryTruth": "#/components/schemas/IValidationTruthAttachCategoryTruth", + "BoundingBoxTruth": "#/components/schemas/IValidationTruthBoundingBoxTruth", + "ClassifyTruth": "#/components/schemas/IValidationTruthClassifyTruth", + "CompareTruth": "#/components/schemas/IValidationTruthCompareTruth", + "EmptyValidationTruth": "#/components/schemas/IValidationTruthEmptyValidationTruth", + "LineTruth": "#/components/schemas/IValidationTruthLineTruth", + "LocateBoxTruth": "#/components/schemas/IValidationTruthLocateBoxTruth", + "MultiCompareTruth": "#/components/schemas/IValidationTruthMultiCompareTruth", + "NamedEntityTruth": "#/components/schemas/IValidationTruthNamedEntityTruth", + "PolygonTruth": "#/components/schemas/IValidationTruthPolygonTruth", + "ScrubTruth": "#/components/schemas/IValidationTruthScrubTruth", + "SkipTruth": "#/components/schemas/IValidationTruthSkipTruth", + "TranscriptionTruth": "#/components/schemas/IValidationTruthTranscriptionTruth" } } }, - "AddUserResponseEndpoint_Input": { + "IValidationTruthAttachCategoryTruth": { "required": [ - "sessionIndex", - "result" + "correctCategories", + "_t" ], - "type": "object", "properties": { - "sessionIndex": { - "type": "integer", - "description": "The index of the session when the result was submitted.", - "format": "int32" - }, - "result": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidResult" - } + "_t": { + "enum": [ + "AttachCategoryTruth" ], - "description": "The result submitted by the user." + "type": "string" + }, + "correctCategories": { + "type": "array", + "items": { + "type": "string" + } } } }, - "AddUserResponseEndpoint_Output": { + "IValidationTruthBoundingBoxTruth": { "required": [ - "isAccepted", - "userScore" + "xMin", + "yMin", + "xMax", + "yMax", + "_t" ], - "type": "object", "properties": { - "isAccepted": { - "type": "boolean", - "description": "Whether the response was accepted." - }, - "validationTruth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } + "_t": { + "enum": [ + "BoundingBoxTruth" ], - "description": "The validation truth applied to the response, if any." + "type": "string" }, - "explanation": { - "allOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "description": "An optional translated explanation for the user." + "xMin": { + "type": "number", + "format": "double" }, - "userScore": { + "yMin": { "type": "number", - "description": "The user's score after processing this response.", "format": "double" }, - "nextRapid": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapid" - } - ], - "description": "The next rapid to solve when the session streams its rapids and continues.\n Null when there is nothing further to solve." + "xMax": { + "type": "number", + "format": "double" + }, + "yMax": { + "type": "number", + "format": "double" } } }, - "AttachCategoryRapid_Category": { + "IValidationTruthClassifyTruth": { "required": [ - "value", - "label" + "correctCategories", + "_t" ], - "type": "object", "properties": { - "value": { + "_t": { + "enum": [ + "ClassifyTruth" + ], "type": "string" }, - "label": { - "$ref": "#/components/schemas/TranslatedString" + "correctCategories": { + "type": "array", + "items": { + "type": "string" + } } } }, - "ClassifyPayload": { + "IValidationTruthCompareTruth": { "required": [ - "categories", - "title" + "winnerId", + "_t" ], - "type": "object", "properties": { - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ClassifyPayload_Category" - } + "_t": { + "enum": [ + "CompareTruth" + ], + "type": "string" }, - "title": { + "winnerId": { "type": "string" } } }, - "CreateDemographicRapidEndpoint_Input": { + "IValidationTruthEmptyValidationTruth": { "required": [ - "key", - "payload" + "_t" ], - "type": "object", "properties": { - "key": { - "type": "string", - "description": "The identifier of the demographic classification." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/ClassifyPayload" - } - ], - "description": "The payload for the classification." - }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - ], - "description": "Optional feature flags to apply to the rapid." - }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "An optional asset to associate with the rapid." - }, - "context": { - "type": "string", - "description": "An optional text context to show to the user.", - "nullable": true - }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } + "_t": { + "enum": [ + "EmptyValidationTruth" ], - "description": "An optional asset to use as context to show to the user." + "type": "string" } } }, - "CreateDemographicRapidEndpoint_Output": { + "IValidationTruthLineTruth": { "required": [ - "rapidId" + "_t" ], - "type": "object", "properties": { - "rapidId": { - "type": "string", - "description": "The id of the created rapid." + "_t": { + "enum": [ + "LineTruth" + ], + "type": "string" } } }, - "CreateGlobalTextEndpoint_Input": { + "IValidationTruthLocateBoxTruth": { "required": [ - "key", - "englishText" + "boundingBoxes", + "_t" ], - "type": "object", "properties": { - "key": { - "type": "string", - "description": "The human-readable key used to look up the text from translations." + "_t": { + "enum": [ + "LocateBoxTruth" + ], + "type": "string" }, - "englishText": { - "type": "string", - "description": "The English source text that all translations derive from." + "boundingBoxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocateBoxTruth_Box" + } + }, + "requiredPrecision": { + "type": "number", + "format": "double" + }, + "requiredCompleteness": { + "type": "number", + "format": "double" } } }, - "CreateGlobalTextEndpoint_Output": { + "IValidationTruthMultiCompareTruth": { "required": [ - "globalTextId" + "correctCombinations", + "_t" ], - "type": "object", "properties": { - "globalTextId": { - "type": "string", - "description": "The unique identifier of the created global text entry." + "_t": { + "enum": [ + "MultiCompareTruth" + ], + "type": "string" + }, + "correctCombinations": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } } } }, - "CreateValidationFeedbackEndpoint_Input": { + "IValidationTruthNamedEntityTruth": { "required": [ - "feedback" + "classifications", + "_t" ], - "type": "object", "properties": { - "feedback": { - "type": "string", - "description": "The feedback text." + "_t": { + "enum": [ + "NamedEntityTruth" + ], + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NamedEntityTruth_NamedClassification" + } } } }, - "GetAllGlobalTextsEndpoint_Output": { + "IValidationTruthPolygonTruth": { "required": [ - "globalTexts" + "_t" ], - "type": "object", "properties": { - "globalTexts": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetAllGlobalTextsEndpoint_Output_Item" - } - } + "_t": { + "enum": [ + "PolygonTruth" ], - "description": "The list of global text entries." + "type": "string" } } }, - "GetAllGlobalTextsEndpoint_Output_Item": { + "IValidationTruthScrubTruth": { "required": [ - "id", - "key", - "englishText" + "validRanges", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string" - }, - "key": { + "_t": { + "enum": [ + "ScrubTruth" + ], "type": "string" }, - "englishText": { - "type": "string" + "validRanges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScrubTruth_ScrubRange" + } } } }, - "GetGlobalResponsesEndpoint_Output": { + "IValidationTruthSkipTruth": { "required": [ - "responses" + "_t" ], - "type": "object", "properties": { - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output_Response" - } - } + "_t": { + "enum": [ + "SkipTruth" ], - "description": "The most recent public responses." - } - } - }, - "GetGlobalResponsesEndpoint_Output_Response": { - "required": [ - "id", - "userId", - "country" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { "type": "string" - }, - "age": { - "type": "string", - "nullable": true - }, - "occupation": { - "type": "string", - "nullable": true - }, - "gender": { - "type": "string", - "nullable": true } } }, - "GetRapidNavigationEndpoint_Card": { + "IValidationTruthTranscriptionTruth": { "required": [ - "rapidId", - "asset", - "state", - "payload", - "responses", - "totalResponseCount" + "correctWords", + "_t" ], - "type": "object", "properties": { - "rapidId": { + "_t": { + "enum": [ + "TranscriptionTruth" + ], "type": "string" }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "state": { - "$ref": "#/components/schemas/RapidState" - }, - "payload": { - "$ref": "#/components/schemas/IRapidPayload" - }, - "responses": { + "correctWords": { "type": "array", "items": { - "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Card_Response" + "$ref": "#/components/schemas/TranscriptionTruth_TranscriptionWord" } }, - "totalResponseCount": { - "type": "integer", - "format": "int64" - }, - "context": { - "type": "string", - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], + "strictGrading": { + "type": "boolean", "nullable": true }, - "decisiveness": { + "requiredPrecision": { "type": "number", "format": "double", "nullable": true }, - "aggregation": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IResponseAggregation" - } - ], + "requiredCompleteness": { + "type": "number", + "format": "double", "nullable": true } } }, - "GetRapidNavigationEndpoint_Card_Response": { - "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" - ], + "LocateBoxTruth_Box": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" - }, - "age": { - "type": "string", + "xMin": { + "type": "number", + "format": "double", "nullable": true }, - "gender": { - "type": "string", + "yMin": { + "type": "number", + "format": "double", "nullable": true }, - "occupation": { - "type": "string", + "xMax": { + "type": "number", + "format": "double", "nullable": true }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { + "yMax": { "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } + "format": "double", + "nullable": true } } }, - "GetRapidNavigationEndpoint_Item": { + "NamedEntityTruth_NamedClassification": { "required": [ - "rapidId", - "asset", - "state" + "start", + "end", + "classification" ], "type": "object", "properties": { - "rapidId": { - "type": "string" + "start": { + "type": "integer", + "format": "int32" }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "end": { + "type": "integer", + "format": "int32" }, - "state": { - "$ref": "#/components/schemas/RapidState" + "classification": { + "type": "string" } } }, - "GetRapidNavigationEndpoint_Output": { + "QueryFlaggedRapidsEndpoint_Output": { "required": [ - "current", - "previous", - "next", - "index", - "total" + "id", + "payload", + "referee", + "asset", + "state", + "hasResponses", + "shouldAcceptIncorrect", + "truth", + "explanation", + "randomCorrectProbability", + "key", + "completedAt", + "featureFlags" ], "type": "object", "properties": { - "current": { + "id": { + "type": "string", + "description": "The unique identifier of the rapid." + }, + "payload": { "allOf": [ { - "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Card" + "$ref": "#/components/schemas/IRapidPayload" } ], - "description": "The anchor rapid, carrying the same fields a results-grid card renders." + "description": "The payload of the rapid." }, - "previous": { + "referee": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Item" - } + "$ref": "#/components/schemas/IRefereeInfo" } ], - "description": "The rapids preceding the anchor in grid order, at most window entries,\n ordered ascending with the neighbour adjacent to the anchor last." + "description": "The referee that created the rapid." }, - "next": { + "asset": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Item" - } + "$ref": "#/components/schemas/IAsset" } ], - "description": "The rapids following the anchor in grid order, at most window entries,\n in ascending order." - }, - "index": { - "type": "integer", - "description": "The 1-based position of the anchor within the filtered slice.", - "format": "int64" - }, - "total": { - "type": "integer", - "description": "The total number of rapids in the filtered slice.", - "format": "int64" - } - } - }, - "GetResponsesForRapidEndpoint_Output": { - "required": [ - "rapidId", - "asset", - "responses", - "state" - ], - "type": "object", - "properties": { - "rapidId": { - "type": "string", - "description": "The id of the rapid." + "description": "The asset associated with the rapid." }, - "asset": { + "state": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/RapidState" } ], - "description": "The asset of the rapid." + "description": "The state of the rapid." }, - "responses": { + "hasResponses": { + "type": "boolean", + "description": "Whether the rapid has any responses." + }, + "shouldAcceptIncorrect": { + "type": "boolean", + "description": "Whether the rapid should accept incorrect answers." + }, + "truth": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output_Response" - } + "$ref": "#/components/schemas/IValidationTruth" } ], - "description": "The list of responses for the rapid." + "description": "The optional validation truth of the rapid." }, - "state": { + "explanation": { + "type": "string", + "description": "The optional explanation shown when users answer incorrectly.", + "nullable": true + }, + "randomCorrectProbability": { + "type": "number", + "description": "The probability of a random correct answer.", + "format": "double", + "nullable": true + }, + "key": { + "type": "string", + "description": "An optional key for the rapid.", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "The timestamp when the rapid was completed.", + "format": "date-time", + "nullable": true + }, + "featureFlags": { "allOf": [ { - "$ref": "#/components/schemas/RapidState" + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } } ], - "description": "The state of the rapid." + "description": "The feature flags enabled for the rapid." } } }, - "GetResponsesForRapidEndpoint_Output_Response": { - "required": [ - "id", - "userId", - "country", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { - "type": "string", - "nullable": true - }, - "occupation": { - "type": "string", - "nullable": true - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "InspectReportEndpoint_Output": { - "type": "object", - "properties": { - "dump": { - "type": "string", - "description": "The captured dump, if any.", - "nullable": true - } - } - }, - "IRapid": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRapidAttachCategoryRapid" - }, - { - "$ref": "#/components/schemas/IRapidBoundingBoxRapid" - }, - { - "$ref": "#/components/schemas/IRapidCompareRapid" - }, - { - "$ref": "#/components/schemas/IRapidFreeTextRapid" - }, - { - "$ref": "#/components/schemas/IRapidLineRapid" - }, - { - "$ref": "#/components/schemas/IRapidLocateRapid" - }, - { - "$ref": "#/components/schemas/IRapidNamedEntityRapid" - }, - { - "$ref": "#/components/schemas/IRapidPolygonRapid" - }, - { - "$ref": "#/components/schemas/IRapidScrubRapid" - }, - { - "$ref": "#/components/schemas/IRapidTranscriptionRapid" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "AttachCategoryRapidModel": "#/components/schemas/IRapidAttachCategoryRapid", - "BoundingBoxRapidModel": "#/components/schemas/IRapidBoundingBoxRapid", - "CompareRapidModel": "#/components/schemas/IRapidCompareRapid", - "FreeTextRapidModel": "#/components/schemas/IRapidFreeTextRapid", - "LineRapidModel": "#/components/schemas/IRapidLineRapid", - "LocateRapidModel": "#/components/schemas/IRapidLocateRapid", - "NamedEntityRapidModel": "#/components/schemas/IRapidNamedEntityRapid", - "PolygonRapidModel": "#/components/schemas/IRapidPolygonRapid", - "ScrubRapidModel": "#/components/schemas/IRapidScrubRapid", - "TranscriptionRapidModel": "#/components/schemas/IRapidTranscriptionRapid" - } - } - }, - "IRapidAttachCategoryRapid": { - "required": [ - "categories", - "title", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "AttachCategoryRapidModel" - ], - "type": "string" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachCategoryRapid_Category" - } - }, - "title": { - "$ref": "#/components/schemas/TranslatedString" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" - } - } - }, - "IRapidBoundingBoxRapid": { - "required": [ - "target", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BoundingBoxRapidModel" - ], - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/TranslatedString" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" - } - } - }, - "IRapidCompareRapid": { - "required": [ - "criteria", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CompareRapidModel" - ], - "type": "string" - }, - "criteria": { - "$ref": "#/components/schemas/TranslatedString" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" - } - } - }, - "IRapidFreeTextRapid": { - "required": [ - "question", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FreeTextRapidModel" - ], - "type": "string" - }, - "question": { - "$ref": "#/components/schemas/TranslatedString" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" - } - } - }, - "IRapidLineRapid": { - "required": [ - "target", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LineRapidModel" - ], - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/TranslatedString" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" - } - } - }, - "IRapidLocateRapid": { - "required": [ - "target", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocateRapidModel" - ], - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/TranslatedString" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" - } - } - }, - "IRapidNamedEntityRapid": { - "required": [ - "target", - "classes", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NamedEntityRapidModel" - ], - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/TranslatedString" - }, - "classes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranslatedString" - } - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" - } - } - }, - "IRapidPolygonRapid": { - "required": [ - "target", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonRapidModel" - ], - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/TranslatedString" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" - } - } - }, - "IRapidScrubRapid": { - "required": [ - "target", - "id", - "featureFlags", - "asset", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScrubRapidModel" - ], - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/TranslatedString" - }, - "id": { - "type": "string" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - } - } - }, - "IRapidTranscriptionRapid": { - "required": [ - "transcription", - "title", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TranscriptionRapidModel" - ], - "type": "string" - }, - "transcription": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionRapid_TranscriptionWord" - } - }, - "title": { - "$ref": "#/components/schemas/TranslatedString" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" - } - } - }, - "IRefereeInfo": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRefereeInfoNaiveRefereeInfo" - }, - { - "$ref": "#/components/schemas/IRefereeInfoNeverEndingRefereeInfo" - }, - { - "$ref": "#/components/schemas/IRefereeInfoProbabilisticAttachCategoryRefereeInfo" - }, - { - "$ref": "#/components/schemas/IRefereeInfoQuorumRefereeInfo" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "NaiveRefereeInfo": "#/components/schemas/IRefereeInfoNaiveRefereeInfo", - "NeverEndingRefereeInfo": "#/components/schemas/IRefereeInfoNeverEndingRefereeInfo", - "ProbabilisticAttachCategoryRefereeInfo": "#/components/schemas/IRefereeInfoProbabilisticAttachCategoryRefereeInfo", - "QuorumRefereeInfo": "#/components/schemas/IRefereeInfoQuorumRefereeInfo" - } - } - }, - "IRefereeInfoNaiveRefereeInfo": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NaiveRefereeInfo" - ], - "type": "string" - }, - "responseAmountThreshold": { - "type": "integer", - "format": "int32" - }, - "serveThreshold": { - "type": "integer", - "format": "int32", - "nullable": true - } - } - }, - "IRefereeInfoNeverEndingRefereeInfo": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NeverEndingRefereeInfo" - ], - "type": "string" - } - } - }, - "IRefereeInfoProbabilisticAttachCategoryRefereeInfo": { - "required": [ - "threshold", - "maxVotes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ProbabilisticAttachCategoryRefereeInfo" - ], - "type": "string" - }, - "threshold": { - "type": "number", - "format": "double" - }, - "maxVotes": { - "type": "integer", - "format": "int32" - } - } - }, - "IRefereeInfoQuorumRefereeInfo": { - "required": [ - "maxVotes", - "threshold", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "QuorumRefereeInfo" - ], - "type": "string" - }, - "maxVotes": { - "type": "integer", - "format": "int32" - }, - "threshold": { - "type": "integer", - "format": "int32" - } - } - }, - "IsRapidBagValidEndpoint_Output": { - "required": [ - "isValid" - ], - "type": "object", - "properties": { - "isValid": { - "type": "boolean", - "description": "Whether the rapid bag is valid." - } - } - }, - "IValidationTruth": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IValidationTruthAttachCategoryTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthBoundingBoxTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthClassifyTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthCompareTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthEmptyValidationTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthLineTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthLocateBoxTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthMultiCompareTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthNamedEntityTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthPolygonTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthScrubTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthSkipTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthTranscriptionTruth" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "AttachCategoryTruth": "#/components/schemas/IValidationTruthAttachCategoryTruth", - "BoundingBoxTruth": "#/components/schemas/IValidationTruthBoundingBoxTruth", - "ClassifyTruth": "#/components/schemas/IValidationTruthClassifyTruth", - "CompareTruth": "#/components/schemas/IValidationTruthCompareTruth", - "EmptyValidationTruth": "#/components/schemas/IValidationTruthEmptyValidationTruth", - "LineTruth": "#/components/schemas/IValidationTruthLineTruth", - "LocateBoxTruth": "#/components/schemas/IValidationTruthLocateBoxTruth", - "MultiCompareTruth": "#/components/schemas/IValidationTruthMultiCompareTruth", - "NamedEntityTruth": "#/components/schemas/IValidationTruthNamedEntityTruth", - "PolygonTruth": "#/components/schemas/IValidationTruthPolygonTruth", - "ScrubTruth": "#/components/schemas/IValidationTruthScrubTruth", - "SkipTruth": "#/components/schemas/IValidationTruthSkipTruth", - "TranscriptionTruth": "#/components/schemas/IValidationTruthTranscriptionTruth" - } - } - }, - "IValidationTruthAttachCategoryTruth": { - "required": [ - "correctCategories", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "AttachCategoryTruth" - ], - "type": "string" - }, - "correctCategories": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IValidationTruthBoundingBoxTruth": { - "required": [ - "xMin", - "yMin", - "xMax", - "yMax", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BoundingBoxTruth" - ], - "type": "string" - }, - "xMin": { - "type": "number", - "format": "double" - }, - "yMin": { - "type": "number", - "format": "double" - }, - "xMax": { - "type": "number", - "format": "double" - }, - "yMax": { - "type": "number", - "format": "double" - } - } - }, - "IValidationTruthClassifyTruth": { - "required": [ - "correctCategories", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyTruth" - ], - "type": "string" - }, - "correctCategories": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IValidationTruthCompareTruth": { - "required": [ - "winnerId", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CompareTruth" - ], - "type": "string" - }, - "winnerId": { - "type": "string" - } - } - }, - "IValidationTruthEmptyValidationTruth": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "EmptyValidationTruth" - ], - "type": "string" - } - } - }, - "IValidationTruthLineTruth": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LineTruth" - ], - "type": "string" - } - } - }, - "IValidationTruthLocateBoxTruth": { - "required": [ - "boundingBoxes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocateBoxTruth" - ], - "type": "string" - }, - "boundingBoxes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LocateBoxTruth_Box" - } - }, - "requiredPrecision": { - "type": "number", - "format": "double" - }, - "requiredCompleteness": { - "type": "number", - "format": "double" - } - } - }, - "IValidationTruthMultiCompareTruth": { - "required": [ - "correctCombinations", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "MultiCompareTruth" - ], - "type": "string" - }, - "correctCombinations": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "IValidationTruthNamedEntityTruth": { - "required": [ - "classifications", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NamedEntityTruth" - ], - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NamedEntityTruth_NamedClassification" - } - } - } - }, - "IValidationTruthPolygonTruth": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonTruth" - ], - "type": "string" - } - } - }, - "IValidationTruthScrubTruth": { - "required": [ - "validRanges", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScrubTruth" - ], - "type": "string" - }, - "validRanges": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScrubTruth_ScrubRange" - } - } - } - }, - "IValidationTruthSkipTruth": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "SkipTruth" - ], - "type": "string" - } - } - }, - "IValidationTruthTranscriptionTruth": { - "required": [ - "correctWords", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TranscriptionTruth" - ], - "type": "string" - }, - "correctWords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionTruth_TranscriptionWord" - } - }, - "strictGrading": { - "type": "boolean", - "nullable": true - }, - "requiredPrecision": { - "type": "number", - "format": "double", - "nullable": true - }, - "requiredCompleteness": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "LocateBoxTruth_Box": { - "type": "object", - "properties": { - "xMin": { - "type": "number", - "format": "double", - "nullable": true - }, - "yMin": { - "type": "number", - "format": "double", - "nullable": true - }, - "xMax": { - "type": "number", - "format": "double", - "nullable": true - }, - "yMax": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "NamedEntityTruth_NamedClassification": { - "required": [ - "start", - "end", - "classification" - ], - "type": "object", - "properties": { - "start": { - "type": "integer", - "format": "int32" - }, - "end": { - "type": "integer", - "format": "int32" - }, - "classification": { - "type": "string" - } - } - }, - "QueryFlaggedRapidsEndpoint_Output": { - "required": [ - "id", - "payload", - "referee", - "asset", - "state", - "hasResponses", - "shouldAcceptIncorrect", - "truth", - "explanation", - "randomCorrectProbability", - "key", - "completedAt", - "featureFlags" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." - }, - "referee": { - "allOf": [ - { - "$ref": "#/components/schemas/IRefereeInfo" - } - ], - "description": "The referee that created the rapid." - }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The asset associated with the rapid." - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidState" - } - ], - "description": "The state of the rapid." - }, - "hasResponses": { - "type": "boolean", - "description": "Whether the rapid has any responses." - }, - "shouldAcceptIncorrect": { - "type": "boolean", - "description": "Whether the rapid should accept incorrect answers." - }, - "truth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The optional validation truth of the rapid." - }, - "explanation": { - "type": "string", - "description": "The optional explanation shown when users answer incorrectly.", - "nullable": true - }, - "randomCorrectProbability": { - "type": "number", - "description": "The probability of a random correct answer.", - "format": "double", - "nullable": true - }, - "key": { - "type": "string", - "description": "An optional key for the rapid.", - "nullable": true - }, - "completedAt": { - "type": "string", - "description": "The timestamp when the rapid was completed.", - "format": "date-time", - "nullable": true - }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "The feature flags enabled for the rapid." - } - } - }, - "QueryFlaggedRapidsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "QueryValidationFeedbacksEndpoint_Output": { - "required": [ - "id", - "userId", - "sessionId", - "feedback", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the feedback." - }, - "userId": { - "type": "string", - "description": "The ID of the user who submitted the feedback." - }, - "sessionId": { - "type": "string", - "description": "The session ID of the user who submitted the feedback." - }, - "feedback": { - "type": "string", - "description": "The feedback text." - }, - "englishFeedback": { - "type": "string", - "description": "The English translation of the feedback, or null when unavailable.", - "nullable": true - }, - "createdAt": { - "type": "string", - "description": "The timestamp when the feedback was created.", - "format": "date-time" - } - } - }, - "QueryValidationFeedbacksEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryValidationFeedbacksEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "QueryValidationRapidEligibilityEndpoint_Output": { - "required": [ - "rapidId", - "payload", - "responseCount", - "confidence", - "truth" - ], - "type": "object", - "properties": { - "rapidId": { - "type": "string", - "description": "The id of the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." - }, - "responseCount": { - "type": "integer", - "description": "The number of responses that the rapid has received.", - "format": "int32" - }, - "confidence": { - "type": "number", - "description": "The confidence of the rapid's aggregated response.", - "format": "double" - }, - "truth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The derived validation truth for the rapid." - } - } - }, - "QueryValidationRapidEligibilityEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryValidationRapidEligibilityEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "RapidIssue": { - "enum": [ - "Other", - "CannotSubmit", - "NoAsset", - "Inappropriate", - "NoCorrectOption", - "WrongLanguage", - "DoNotUnderstand", - "DoNotCare", - "NotSeeOptionsOrMediaDidntLoad", - "MyAnswerIsCorrect" - ] - }, - "ReportRapidEndpoint_Input": { - "required": [ - "issue" - ], - "type": "object", - "properties": { - "issue": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidIssue" - } - ], - "description": "A streamlined enum representing common issues." - }, - "message": { - "type": "string", - "description": "An optional message typed by the user.", - "nullable": true - }, - "dump": { - "type": "string", - "description": "A dump that the frontend defines and can read again.", - "nullable": true - }, - "source": { - "type": "string", - "description": "An optional identifier where the report originated from.", - "nullable": true - } - } - }, - "ScrubTruth_ScrubRange": { - "required": [ - "start", - "end" - ], - "type": "object", - "properties": { - "start": { - "type": "integer", - "format": "int32" - }, - "end": { - "type": "integer", - "format": "int32" - } - } - }, - "SkipRapidEndpoint_Input": { - "required": [ - "rapidId", - "sessionIndex" - ], - "type": "object", - "properties": { - "rapidId": { - "type": "string", - "description": "The ID of the Rapid that was skipped." - }, - "sessionIndex": { - "type": "integer", - "description": "The index of the session when the Rapid was skipped.", - "format": "int32" - } - } - }, - "SkipRapidEndpoint_Output": { - "required": [ - "isAccepted", - "userScore" - ], - "type": "object", - "properties": { - "isAccepted": { - "type": "boolean", - "description": "Whether the skip was accepted." - }, - "validationTruth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The validation truth applied, if any." - }, - "explanation": { - "allOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "description": "An optional translated explanation for the user." - }, - "userScore": { - "type": "number", - "description": "The user's score after the skip.", - "format": "double" - }, - "nextRapid": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapid" - } - ], - "description": "The next rapid to solve when the session streams its rapids and continues.\n Null when there is nothing further to solve." - } - } - }, - "TranscriptionRapid_TranscriptionWord": { - "required": [ - "word", - "wordIndex" - ], - "type": "object", - "properties": { - "word": { - "type": "string" - }, - "wordIndex": { - "type": "integer", - "format": "int32" - } - } - }, - "TranscriptionTruth_TranscriptionWord": { - "required": [ - "word", - "wordIndex" - ], - "type": "object", - "properties": { - "word": { - "type": "string" - }, - "wordIndex": { - "type": "integer", - "format": "int32" - } - } - }, - "TranslatedString": { - "required": [ - "englishText", - "text", - "targetLanguage" - ], - "type": "object", - "properties": { - "wasTranslated": { - "type": "boolean" - }, - "englishText": { - "type": "string" - }, - "text": { - "type": "string" - }, - "targetLanguage": { - "type": "string" - } - } - }, - "UpdateGlobalTextEndpoint_Input": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The new key for the global text entry." - }, - "englishText": { - "type": "string", - "description": "The new English source text for the global text entry." - } - } - }, - "UpdateValidationRapidEndpoint_Input": { - "type": "object", - "properties": { - "truth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The truth for the validation rapid." - }, - "explanation": { - "type": "string", - "description": "The optional explanation shown when users answer incorrectly.", - "nullable": true - }, - "context": { - "type": "string", - "description": "An optional text context to show the user.", - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "An optional asset to use as context to show the user.", - "nullable": true - }, - "randomCorrectProbability": { - "type": "number", - "description": "The probability that a random answer is correct.", - "format": "double", - "nullable": true - }, - "sortIndex": { - "type": "integer", - "description": "Controls the serving order of rapids within a target group.", - "format": "int32" - } - } - }, - "CreateSignalEndpoint_Input": { - "required": [ - "name", - "audienceId", - "jobDefinitionId", - "intervalSeconds" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The human-readable name of the signal." - }, - "description": { - "type": "string", - "description": "Optional description.", - "nullable": true - }, - "audienceId": { - "type": "string", - "description": "The audience the spawned jobs will target." - }, - "jobDefinitionId": { - "type": "string", - "description": "The job definition each firing creates a job from." - }, - "revisionNumber": { - "type": "integer", - "description": "Optional revision pin; omit for \"latest at fire time\".", - "format": "int32", - "nullable": true - }, - "intervalSeconds": { - "type": "integer", - "description": "Seconds between consecutive firings. Minimum 60.", - "format": "int32" - }, - "isPublic": { - "type": "boolean", - "description": "If true the signal is readable by every authenticated user." - } - } - }, - "CreateSignalEndpoint_Output": { - "required": [ - "id", - "nextRunAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the created signal." - }, - "nextRunAt": { - "type": "string", - "description": "Timestamp at which the first scheduled run will fire.", - "format": "date-time" - } - } - }, - "GetSignalByIdEndpoint_Output": { - "required": [ - "id", - "name", - "audienceId", - "jobDefinitionId", - "intervalSeconds", - "nextRunAt", - "isPaused", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the signal." - }, - "name": { - "type": "string", - "description": "The human-readable name of the signal." - }, - "description": { - "type": "string", - "description": "Optional description.", - "nullable": true - }, - "audienceId": { - "type": "string", - "description": "The id of the audience the signal targets." - }, - "jobDefinitionId": { - "type": "string", - "description": "The id of the job definition each firing creates a job from." - }, - "revisionNumber": { - "type": "integer", - "description": "Pinned revision number; null means \"latest at fire time\".", - "format": "int32", - "nullable": true - }, - "intervalSeconds": { - "type": "integer", - "description": "Seconds between consecutive firings.", - "format": "int32" - }, - "nextRunAt": { - "type": "string", - "description": "Timestamp of the next scheduled run.", - "format": "date-time" - }, - "lastRunAt": { - "type": "string", - "description": "Timestamp of the most recent run (null if the signal has never fired).", - "format": "date-time", - "nullable": true - }, - "isPaused": { - "type": "boolean", - "description": "Whether the scheduler is currently skipping this signal." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the signal is readable by every authenticated user." - }, - "ownerId": { - "type": "string", - "description": "The customer id of the signal owner.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The email of the signal owner." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - }, - "createdAt": { - "type": "string", - "description": "When the signal was created.", - "format": "date-time" - } - } - }, - "GetSignalRunByIdEndpoint_Output": { - "required": [ - "id", - "signalId", - "triggerSource", - "status", - "startedAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the run." - }, - "signalId": { - "type": "string", - "description": "The id of the parent signal." - }, - "triggerSource": { - "allOf": [ - { - "$ref": "#/components/schemas/SignalRunTriggerSource" - } - ], - "description": "Whether the run was started by the scheduler or by a manual trigger." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/SignalRunStatus" - } - ], - "description": "Current lifecycle state of the run." - }, - "startedAt": { - "type": "string", - "description": "When the run was started.", - "format": "date-time" - }, - "audienceJobId": { - "type": "string", - "description": "The id of the audience job this run spawned (null until orders confirms creation).", - "nullable": true - }, - "completedAt": { - "type": "string", - "description": "When the run reached a terminal state.", - "format": "date-time", - "nullable": true - }, - "resultFileName": { - "type": "string", - "description": "File name of the audience-job result, when completed.", - "nullable": true - }, - "failureMessage": { - "type": "string", - "description": "Reason the run failed.", - "nullable": true - }, - "skippedReason": { - "type": "string", - "description": "Reason the run was skipped without spawning an audience job.", - "nullable": true - } - } - }, - "QuerySignalRunsEndpoint_Output": { - "required": [ - "id", - "signalId", - "triggerSource", - "status", - "startedAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the run." - }, - "signalId": { - "type": "string", - "description": "The id of the parent signal." - }, - "triggerSource": { - "allOf": [ - { - "$ref": "#/components/schemas/SignalRunTriggerSource" - } - ], - "description": "Whether the run was started by the scheduler or by a manual trigger." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/SignalRunStatus" - } - ], - "description": "Current lifecycle state of the run." - }, - "startedAt": { - "type": "string", - "description": "When the run was started.", - "format": "date-time" - }, - "audienceJobId": { - "type": "string", - "description": "The id of the audience job this run spawned (null until orders confirms creation).", - "nullable": true - }, - "completedAt": { - "type": "string", - "description": "When the run reached a terminal state.", - "format": "date-time", - "nullable": true - }, - "resultFileName": { - "type": "string", - "description": "File name of the audience-job result, when completed.", - "nullable": true - }, - "failureMessage": { - "type": "string", - "description": "Reason the run failed.", - "nullable": true - }, - "skippedReason": { - "type": "string", - "description": "Reason the run was skipped without spawning an audience job.", - "nullable": true - } - } - }, - "QuerySignalRunsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuerySignalRunsEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "QuerySignalsEndpoint_Output": { - "required": [ - "id", - "name", - "audienceId", - "jobDefinitionId", - "intervalSeconds", - "nextRunAt", - "isPaused", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the signal." - }, - "name": { - "type": "string", - "description": "The human-readable name of the signal." - }, - "description": { - "type": "string", - "description": "Optional description.", - "nullable": true - }, - "audienceId": { - "type": "string", - "description": "The id of the audience the signal targets." - }, - "jobDefinitionId": { - "type": "string", - "description": "The id of the job definition each firing creates a job from." - }, - "revisionNumber": { - "type": "integer", - "description": "Pinned revision number; null means \"latest at fire time\".", - "format": "int32", - "nullable": true - }, - "intervalSeconds": { - "type": "integer", - "description": "Seconds between consecutive firings.", - "format": "int32" - }, - "nextRunAt": { - "type": "string", - "description": "Timestamp of the next scheduled run.", - "format": "date-time" - }, - "lastRunAt": { - "type": "string", - "description": "Timestamp of the most recent run (null if the signal has never fired).", - "format": "date-time", - "nullable": true - }, - "isPaused": { - "type": "boolean", - "description": "Whether the scheduler is currently skipping this signal." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the signal is readable by every authenticated user." - }, - "ownerId": { - "type": "string", - "description": "The customer id of the signal owner.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The email of the signal owner." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - }, - "createdAt": { - "type": "string", - "description": "When the signal was created.", - "format": "date-time" - } - } - }, - "QuerySignalsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuerySignalsEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "SignalRunStatus": { - "enum": [ - "Pending", - "Running", - "Completed", - "Failed", - "Skipped" - ] - }, - "SignalRunTriggerSource": { - "enum": [ - "Scheduled", - "Manual" - ] - }, - "TriggerSignalEndpoint_Output": { - "required": [ - "signalId" - ], - "type": "object", - "properties": { - "signalId": { - "type": "string", - "description": "Echoes the signal id; the spawned run is created asynchronously." - } - } - }, - "UpdateSignalEndpoint_Input": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The new name of the signal." - }, - "description": { - "type": "string", - "description": "The new description; pass null to clear it.", - "nullable": true - }, - "intervalSeconds": { - "type": "integer", - "description": "The new cadence in seconds. Minimum 60.", - "format": "int32" - } - } - }, - "EnsureEnglishEndpoint_Input": { - "required": [ - "text" - ], - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "The text to ensure is English." - } - } - }, - "EnsureEnglishEndpoint_Output": { - "required": [ - "englishText" - ], - "type": "object", - "properties": { - "englishText": { - "type": "string", - "description": "The English version of the provided text." - } - } - }, - "TranslateEndpoint_Input": { - "required": [ - "translator", - "text", - "targetLanguage" - ], - "type": "object", - "properties": { - "translator": { - "allOf": [ - { - "$ref": "#/components/schemas/TranslatorType" - } - ], - "description": "The type of translator to use." - }, - "text": { - "type": "string", - "description": "The text to translate." - }, - "targetLanguage": { - "type": "string", - "description": "The language to translate the text into." - }, - "sourceLanguage": { - "type": "string", - "description": "The original language of the text." - } - } - }, - "TranslateEndpoint_Output": { - "required": [ - "translation", - "sourceLanguage", - "targetLanguage" - ], - "type": "object", - "properties": { - "translation": { - "type": "string", - "description": "The translated text." - }, - "sourceLanguage": { - "type": "string", - "description": "The detected or provided source language of the text.", - "nullable": true - }, - "targetLanguage": { - "type": "string", - "description": "The language the text was translated into." - } - } - }, - "TranslatorType": { - "enum": [ - "Google", - "Deepl", - "OpenAi", - "OpenAi4O", - "OpenAi4OMini", - "LibreTranslate", - "Gemini", - "Tllm" - ] - }, - "AddValidationRapidEndpoint_Input": { - "required": [ - "asset", - "payload" - ], - "type": "object", - "properties": { - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "The asset to use for the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload to use for the rapid." - }, - "truth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The ground truth for the rapid." - }, - "randomCorrectProbability": { - "type": "number", - "description": "The probability for an answer to be correct when randomly guessing.", - "format": "double", - "nullable": true - }, - "explanation": { - "type": "string", - "description": "An explanation shown to the users if they answer the rapid incorrectly.", - "nullable": true - }, - "context": { - "type": "string", - "description": "An optional textual context that provides additional information to the user about the rapid.", - "nullable": true - }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "An optional asset that provides additional context to the user about the rapid." - }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - ], - "description": "The feature flags to enable for the rapid." - } - } - }, - "AssetType": { - "type": "array", - "items": { - "enum": [ - "None", - "Image", - "Video", - "Audio", - "Text" - ], - "type": "string" - } - }, - "CreateValidationSetEndpoint_Input": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the validation set." - } - } - }, - "CreateValidationSetEndpoint_Output": { - "required": [ - "validationSetId" - ], - "type": "object", - "properties": { - "validationSetId": { - "type": "string", - "description": "The id of the created validation set." - } - } - }, - "GetAvailableValidationSetsEndpoint_Output": { - "required": [ - "validationSets" - ], - "type": "object", - "properties": { - "validationSets": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutput" - } - } - ], - "description": "The validation sets available to the current user's organization." - } - } - }, - "GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutput": { - "required": [ - "id", - "name", - "ownerId" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ownerId": { - "type": "string", - "format": "uuid" - } - } - }, - "GetCompatibleValidationSetsEndpoint_Output": { - "required": [ - "validationSets" - ], - "type": "object", - "properties": { - "validationSets": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetCompatibleValidationSetsEndpoint_ValidationSetOutput" - } - } - ], - "description": "The validation sets that the rapid can be added to." - } - } - }, - "GetCompatibleValidationSetsEndpoint_ValidationSetOutput": { - "required": [ - "id", - "name", - "assetType", - "modality", - "promptType", - "dimensions", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "assetType": { - "$ref": "#/components/schemas/AssetType" - }, - "modality": { - "$ref": "#/components/schemas/RapidModality" - }, - "promptType": { - "$ref": "#/components/schemas/PromptType" - }, - "dimensions": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "isPublic": { - "type": "boolean" - }, - "ownerId": { - "type": "string", - "format": "uuid" - }, - "ownerMail": { - "type": "string" - }, - "organizationId": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time" - } - } - }, - "GetRecommendedValidationSetEndpoint_Output": { - "required": [ - "validationSets" - ], - "type": "object", - "properties": { - "validationSets": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRecommendedValidationSetEndpoint_ValidationSetOutput" - } - } - ], - "description": "The validation sets that best match the provided parameters." - } - } - }, - "GetRecommendedValidationSetEndpoint_ValidationSetOutput": { - "required": [ - "id", - "name", - "assetType", - "modality", - "promptType", - "dimensions", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "assetType": { - "$ref": "#/components/schemas/AssetType" - }, - "modality": { - "$ref": "#/components/schemas/RapidModality" - }, - "promptType": { - "$ref": "#/components/schemas/PromptType" - }, - "dimensions": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "isPublic": { - "type": "boolean" - }, - "ownerId": { - "type": "string", - "format": "uuid" - }, - "ownerMail": { - "type": "string" - }, - "organizationId": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time" - } - } - }, - "GetValidationRapidsEndpoint_Output": { - "required": [ - "id", - "type", - "asset", - "payload", - "correctValidationCount", - "invalidValidationCount", - "state" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the rapid." - }, - "type": { - "type": "string", - "description": "The type of the rapid." - }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The asset associated with the rapid." - }, - "truth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The truth of the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." - }, - "context": { - "type": "string", - "description": "The optional textual context of the rapid.", - "nullable": true - }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The optional asset shown as context to the user." - }, - "correctValidationCount": { - "type": "integer", - "description": "The number of correct validations received.", - "format": "int32" - }, - "invalidValidationCount": { - "type": "integer", - "description": "The number of invalid validations received.", - "format": "int32" - }, - "explanation": { - "type": "string", - "description": "The explanation shown when users answer incorrectly.", - "nullable": true - }, - "randomCorrectProbability": { - "type": "number", - "description": "The probability of a random correct answer.", - "format": "double", - "nullable": true - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidState" - } - ], - "description": "The state of the rapid." - } - } - }, - "GetValidationRapidsEndpoint_PagedResultOfOutput": { + "QueryFlaggedRapidsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -66534,7 +63476,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetValidationRapidsEndpoint_Output" + "$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_Output" } }, "totalPages": { @@ -66543,158 +63485,120 @@ } } }, - "GetValidationSetByIdEndpoint_Output": { + "QueryValidationFeedbacksEndpoint_Output": { "required": [ "id", - "name", - "isPublic", - "ownerMail", - "organizationId", - "ownerId", - "dimensions", + "userId", + "sessionId", + "feedback", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the validation set." + "description": "The unique identifier of the feedback." }, - "name": { + "userId": { "type": "string", - "description": "The name of the validation set." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the validation set is public." + "description": "The ID of the user who submitted the feedback." }, - "ownerMail": { + "sessionId": { "type": "string", - "description": "The mail of the owning customer." + "description": "The session ID of the user who submitted the feedback." }, - "organizationId": { + "feedback": { "type": "string", - "description": "The id of the organization that owns the entity." + "description": "The feedback text." }, - "ownerId": { + "englishFeedback": { "type": "string", - "description": "The id of the owning customer.", - "format": "uuid" - }, - "dimensions": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The dimensions shared across all rapids in the validation set." + "description": "The English translation of the feedback, or null when unavailable.", + "nullable": true }, "createdAt": { "type": "string", - "description": "The time at which the validation set was created.", + "description": "The timestamp when the feedback was created.", "format": "date-time" } } }, - "PromptType": { - "type": "array", - "items": { - "enum": [ - "None", - "Text", - "Asset" - ], - "type": "string" + "QueryValidationFeedbacksEndpoint_PagedResultOfOutput": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int64" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryValidationFeedbacksEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" + } } }, - "QueryValidationSetsEndpoint_Output": { + "QueryValidationRapidEligibilityEndpoint_Output": { "required": [ - "id", - "name", - "assetType", - "modality", - "promptType", - "dimensions", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" + "rapidId", + "payload", + "responseCount", + "confidence", + "truth" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the validation set." - }, - "name": { + "rapidId": { "type": "string", - "description": "The name of the validation set." + "description": "The id of the rapid." }, - "assetType": { + "payload": { "allOf": [ { - "$ref": "#/components/schemas/AssetType" + "$ref": "#/components/schemas/IRapidPayload" } ], - "description": "The asset types contained in the validation set." + "description": "The payload of the rapid." }, - "modality": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidModality" - } - ], - "description": "The rapid modalities contained in the validation set." + "responseCount": { + "type": "integer", + "description": "The number of responses that the rapid has received.", + "format": "int32" }, - "promptType": { - "allOf": [ - { - "$ref": "#/components/schemas/PromptType" - } - ], - "description": "The prompt types contained in the validation set." + "confidence": { + "type": "number", + "description": "The confidence of the rapid's aggregated response.", + "format": "double" }, - "dimensions": { + "truth": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "$ref": "#/components/schemas/IValidationTruth" } ], - "description": "The dimensions shared across all rapids in the validation set." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the validation set is public." - }, - "ownerId": { - "type": "string", - "description": "The id of the owning customer.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The mail of the owning customer." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - }, - "createdAt": { - "type": "string", - "description": "The time at which the validation set was created.", - "format": "date-time" + "description": "The derived validation truth for the rapid." } } }, - "QueryValidationSetsEndpoint_PagedResultOfOutput": { + "QueryValidationRapidEligibilityEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -66718,7 +63622,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryValidationSetsEndpoint_Output" + "$ref": "#/components/schemas/QueryValidationRapidEligibilityEndpoint_Output" } }, "totalPages": { @@ -66727,340 +63631,523 @@ } } }, - "RapidModality": { - "type": "array", - "items": { - "enum": [ - "None", - "BoundingBox", - "Classify", - "Compare", - "FreeText", - "Line", - "Locate", - "NamedEntity", - "Polygon", - "Scrub", - "Transcription" - ], - "type": "string" - } + "RapidIssue": { + "enum": [ + "Other", + "CannotSubmit", + "NoAsset", + "Inappropriate", + "NoCorrectOption", + "WrongLanguage", + "DoNotUnderstand", + "DoNotCare", + "NotSeeOptionsOrMediaDidntLoad", + "MyAnswerIsCorrect" + ] }, - "UpdateValidationSetDimensionsEndpoint_Input": { + "ReportRapidEndpoint_Input": { "required": [ - "dimensions" + "issue" ], "type": "object", "properties": { - "dimensions": { + "issue": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/RapidIssue" } ], - "description": "The dimensions to set on all rapids within the validation set." + "description": "A streamlined enum representing common issues." + }, + "message": { + "type": "string", + "description": "An optional message typed by the user.", + "nullable": true + }, + "dump": { + "type": "string", + "description": "A dump that the frontend defines and can read again.", + "nullable": true + }, + "source": { + "type": "string", + "description": "An optional identifier where the report originated from.", + "nullable": true } } }, - "UpdateValidationSetEndpoint_Input": { + "ScrubTruth_ScrubRange": { + "required": [ + "start", + "end" + ], "type": "object", "properties": { - "name": { + "start": { + "type": "integer", + "format": "int32" + }, + "end": { + "type": "integer", + "format": "int32" + } + } + }, + "SkipRapidEndpoint_Input": { + "required": [ + "rapidId", + "sessionIndex" + ], + "type": "object", + "properties": { + "rapidId": { "type": "string", - "description": "The new name of the validation set." + "description": "The ID of the Rapid that was skipped." }, - "dimensions": { + "sessionIndex": { + "type": "integer", + "description": "The index of the session when the Rapid was skipped.", + "format": "int32" + } + } + }, + "SkipRapidEndpoint_Output": { + "required": [ + "isAccepted", + "userScore" + ], + "type": "object", + "properties": { + "isAccepted": { + "type": "boolean", + "description": "Whether the skip was accepted." + }, + "validationTruth": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/IValidationTruth" } ], - "description": "The new dimensions of the validation set." + "description": "The validation truth applied, if any." }, - "shouldAlert": { - "type": "boolean", - "description": "Whether users should be alerted if they answer incorrectly." + "explanation": { + "allOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "description": "An optional translated explanation for the user." }, - "isPublic": { - "type": "boolean", - "description": "Whether the validation set should be public." + "userScore": { + "type": "number", + "description": "The user's score after the skip.", + "format": "double" }, - "isFlagOverruled": { - "type": "boolean", - "description": "Whether flags on validation rapids should be overruled." + "nextRapid": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapid" + } + ], + "description": "The next rapid to solve when the session streams its rapids and continues.\n Null when there is nothing further to solve." } } }, - "UpdateValidationSetShouldAlertEndpoint_Input": { + "TranscriptionRapid_TranscriptionWord": { "required": [ - "shouldAlert" + "word", + "wordIndex" ], "type": "object", "properties": { - "shouldAlert": { - "type": "boolean", - "description": "A flag indicating whether users should be alerted if they answer incorrectly." + "word": { + "type": "string" + }, + "wordIndex": { + "type": "integer", + "format": "int32" } } }, - "AttachCategoryWorkflowRapidBlueprint_Category": { + "TranscriptionTruth_TranscriptionWord": { "required": [ - "label", - "value" + "word", + "wordIndex" ], "type": "object", "properties": { - "label": { + "word": { "type": "string" }, - "value": { + "wordIndex": { + "type": "integer", + "format": "int32" + } + } + }, + "TranslatedString": { + "required": [ + "englishText", + "text", + "targetLanguage" + ], + "type": "object", + "properties": { + "wasTranslated": { + "type": "boolean" + }, + "englishText": { + "type": "string" + }, + "text": { + "type": "string" + }, + "targetLanguage": { "type": "string" } } }, - "GetCompareAbSummaryEndpoint_Output": { + "UpdateGlobalTextEndpoint_Input": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The new key for the global text entry." + }, + "englishText": { + "type": "string", + "description": "The new English source text for the global text entry." + } + } + }, + "UpdateValidationRapidEndpoint_Input": { + "type": "object", + "properties": { + "truth": { + "allOf": [ + { + "$ref": "#/components/schemas/IValidationTruth" + } + ], + "description": "The truth for the validation rapid." + }, + "explanation": { + "type": "string", + "description": "The optional explanation shown when users answer incorrectly.", + "nullable": true + }, + "context": { + "type": "string", + "description": "An optional text context to show the user.", + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "An optional asset to use as context to show the user.", + "nullable": true + }, + "randomCorrectProbability": { + "type": "number", + "description": "The probability that a random answer is correct.", + "format": "double", + "nullable": true + }, + "sortIndex": { + "type": "integer", + "description": "Controls the serving order of rapids within a target group.", + "format": "int32" + } + } + }, + "CreateSignalEndpoint_Input": { + "required": [ + "name", + "audienceId", + "jobDefinitionId", + "intervalSeconds" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The human-readable name of the signal." + }, + "description": { + "type": "string", + "description": "Optional description.", + "nullable": true + }, + "audienceId": { + "type": "string", + "description": "The audience the spawned jobs will target." + }, + "jobDefinitionId": { + "type": "string", + "description": "The job definition each firing creates a job from." + }, + "revisionNumber": { + "type": "integer", + "description": "Optional revision pin; omit for \"latest at fire time\".", + "format": "int32", + "nullable": true + }, + "intervalSeconds": { + "type": "integer", + "description": "Seconds between consecutive firings. Minimum 60.", + "format": "int32" + }, + "isPublic": { + "type": "boolean", + "description": "If true the signal is readable by every authenticated user." + } + } + }, + "CreateSignalEndpoint_Output": { "required": [ - "winCounter", - "allTargetGroupsCompleted" + "id", + "nextRunAt" ], "type": "object", "properties": { - "winCounter": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - ], - "description": "The number of times each side was the winner, keyed by the side's name and ordered by\n compared side rather than by wins." + "id": { + "type": "string", + "description": "The unique identifier of the created signal." }, - "allTargetGroupsCompleted": { - "type": "boolean", - "description": "Whether all target groups for this workflow are completed." + "nextRunAt": { + "type": "string", + "description": "Timestamp at which the first scheduled run will fire.", + "format": "date-time" } } }, - "GetGroupedRankingWorkflowResultsEndpoint_Output": { + "GetSignalByIdEndpoint_Output": { "required": [ "id", "name", - "state", - "pairMakerInformation" + "audienceId", + "jobDefinitionId", + "intervalSeconds", + "nextRunAt", + "isPaused", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The id of the sub-workflow." + "description": "The unique identifier of the signal." }, "name": { "type": "string", - "description": "The name of the sub-workflow." + "description": "The human-readable name of the signal." }, - "state": { + "description": { "type": "string", - "description": "The state of the sub-workflow." + "description": "Optional description.", + "nullable": true }, - "pairMakerInformation": { - "allOf": [ - { - "$ref": "#/components/schemas/IPairMakerInformation" - } - ], - "description": "Information about the pair-maker used by the sub-workflow." - } - } - }, - "GetGroupedRankingWorkflowResultsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" + "audienceId": { + "type": "string", + "description": "The id of the audience the signal targets." }, - "page": { + "jobDefinitionId": { + "type": "string", + "description": "The id of the job definition each firing creates a job from." + }, + "revisionNumber": { "type": "integer", - "format": "int32" + "description": "Pinned revision number; null means \"latest at fire time\".", + "format": "int32", + "nullable": true }, - "pageSize": { + "intervalSeconds": { "type": "integer", + "description": "Seconds between consecutive firings.", "format": "int32" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetGroupedRankingWorkflowResultsEndpoint_Output" - } + "nextRunAt": { + "type": "string", + "description": "Timestamp of the next scheduled run.", + "format": "date-time" }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "GetRankingWorkflowResultsEndpoint_Datapoint": { - "required": [ - "workflowDatapointId", - "asset", - "elo" - ], - "type": "object", - "properties": { - "workflowDatapointId": { - "type": "string" + "lastRunAt": { + "type": "string", + "description": "Timestamp of the most recent run (null if the signal has never fired).", + "format": "date-time", + "nullable": true }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "isPaused": { + "type": "boolean", + "description": "Whether the scheduler is currently skipping this signal." }, - "elo": { - "type": "integer", - "format": "int32" + "isPublic": { + "type": "boolean", + "description": "Whether the signal is readable by every authenticated user." + }, + "ownerId": { + "type": "string", + "description": "The customer id of the signal owner.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The email of the signal owner." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "When the signal was created.", + "format": "date-time" } } }, - "GetRankingWorkflowResultsEndpoint_Output": { + "GetSignalRunByIdEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "totalVotes", - "items" + "id", + "signalId", + "triggerSource", + "status", + "startedAt" ], "type": "object", "properties": { - "total": { - "type": "integer", - "description": "The total number of items in the result.", - "format": "int64" - }, - "page": { - "type": "integer", - "description": "The current page.", - "format": "int32" + "id": { + "type": "string", + "description": "The unique identifier of the run." }, - "pageSize": { - "type": "integer", - "description": "The size of the page.", - "format": "int32" + "signalId": { + "type": "string", + "description": "The id of the parent signal." }, - "totalVotes": { - "type": "integer", - "description": "The total number of votes across all datapoints.", - "format": "int64" + "triggerSource": { + "allOf": [ + { + "$ref": "#/components/schemas/SignalRunTriggerSource" + } + ], + "description": "Whether the run was started by the scheduler or by a manual trigger." }, - "items": { + "status": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRankingWorkflowResultsEndpoint_Datapoint" - } + "$ref": "#/components/schemas/SignalRunStatus" } ], - "description": "The datapoints on the current page." + "description": "Current lifecycle state of the run." + }, + "startedAt": { + "type": "string", + "description": "When the run was started.", + "format": "date-time" + }, + "audienceJobId": { + "type": "string", + "description": "The id of the audience job this run spawned (null until orders confirms creation).", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "When the run reached a terminal state.", + "format": "date-time", + "nullable": true + }, + "resultFileName": { + "type": "string", + "description": "File name of the audience-job result, when completed.", + "nullable": true + }, + "failureMessage": { + "type": "string", + "description": "Reason the run failed.", + "nullable": true + }, + "skippedReason": { + "type": "string", + "description": "Reason the run was skipped without spawning an audience job.", + "nullable": true } } }, - "GetSimpleWorkflowResultsEndpoint_Output": { + "QuerySignalRunsEndpoint_Output": { "required": [ - "rapidId", - "payload", - "asset", - "responses", - "totalResponseCount", - "state" + "id", + "signalId", + "triggerSource", + "status", + "startedAt" ], "type": "object", "properties": { - "rapidId": { + "id": { "type": "string", - "description": "The id of the rapid." + "description": "The unique identifier of the run." }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." + "signalId": { + "type": "string", + "description": "The id of the parent signal." }, - "asset": { + "triggerSource": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/SignalRunTriggerSource" } ], - "description": "The asset of the rapid." + "description": "Whether the run was started by the scheduler or by a manual trigger." }, - "responses": { + "status": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_ResponseOutput" - } + "$ref": "#/components/schemas/SignalRunStatus" } ], - "description": "The (possibly capped) list of responses for the rapid." + "description": "Current lifecycle state of the run." }, - "totalResponseCount": { - "type": "integer", - "description": "The true number of matching responses for this rapid, regardless of whether the\n returned Responses list was capped.", - "format": "int64" + "startedAt": { + "type": "string", + "description": "When the run was started.", + "format": "date-time" }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidState" - } - ], - "description": "The state of the rapid." + "audienceJobId": { + "type": "string", + "description": "The id of the audience job this run spawned (null until orders confirms creation).", + "nullable": true }, - "context": { + "completedAt": { "type": "string", - "description": "The optional textual context of the rapid.", + "description": "When the run reached a terminal state.", + "format": "date-time", "nullable": true }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The optional asset shown as context to the user." + "resultFileName": { + "type": "string", + "description": "File name of the audience-job result, when completed.", + "nullable": true }, - "decisiveness": { - "type": "number", - "description": "The decisiveness of the rapid.", - "format": "double", + "failureMessage": { + "type": "string", + "description": "Reason the run failed.", "nullable": true }, - "aggregation": { - "allOf": [ - { - "$ref": "#/components/schemas/IResponseAggregation" - } - ], - "description": "Per-payload-type aggregation over all matching responses (computed before sampling).\n Populated for Compare and Classify rapids; null otherwise." + "skippedReason": { + "type": "string", + "description": "Reason the run was skipped without spawning an audience job.", + "nullable": true } } }, - "GetSimpleWorkflowResultsEndpoint_PagedResultOfOutput": { + "QuerySignalRunsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -67084,7 +64171,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_Output" + "$ref": "#/components/schemas/QuerySignalRunsEndpoint_Output" } }, "totalPages": { @@ -67093,284 +64180,95 @@ } } }, - "GetSimpleWorkflowResultsEndpoint_ResponseOutput": { + "QuerySignalsEndpoint_Output": { "required": [ "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" + "name", + "audienceId", + "jobDefinitionId", + "intervalSeconds", + "nextRunAt", + "isPaused", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], "type": "object", "properties": { "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" - }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { - "type": "string", - "nullable": true - }, - "occupation": { "type": "string", - "nullable": true - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "GetWorkflowByIdEndpoint_Output": { - "required": [ - "workflow" - ], - "type": "object", - "properties": { - "workflow": { - "allOf": [ - { - "$ref": "#/components/schemas/IWorkflow" - } - ], - "description": "The workflow." - } - } - }, - "GetWorkflowProgressEndpoint_Output": { - "required": [ - "completionPercentage", - "total", - "completed", - "state" - ], - "type": "object", - "properties": { - "completionPercentage": { - "type": "number", - "description": "The percentage of workflow datapoints that have been completed.", - "format": "double" - }, - "total": { - "type": "integer", - "description": "The total number of datapoints in the workflow.", - "format": "int64" - }, - "completed": { - "type": "integer", - "description": "The number of datapoints that have been completed.", - "format": "int64" - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/WorkflowState" - } - ], - "description": "The current state of the workflow." - } - } - }, - "GetWorkflowResponsesEndpoint_Output": { - "required": [ - "responses" - ], - "type": "object", - "properties": { - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetWorkflowResponsesEndpoint_Response" - } - } - ], - "description": "The responses for the workflow." - } - } - }, - "GetWorkflowResponsesEndpoint_Response": { - "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" + "description": "The unique identifier of the signal." }, - "age": { + "name": { "type": "string", - "nullable": true + "description": "The human-readable name of the signal." }, - "gender": { + "description": { "type": "string", + "description": "Optional description.", "nullable": true }, - "occupation": { + "audienceId": { "type": "string", - "nullable": true - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" + "description": "The id of the audience the signal targets." }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "GetWorkflowResultsEndpoint_Output": { - "required": [ - "rapidId", - "payload", - "asset", - "responses", - "totalResponseCount", - "state" - ], - "type": "object", - "properties": { - "rapidId": { + "jobDefinitionId": { "type": "string", - "description": "The id of the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." - }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The asset of the rapid." + "description": "The id of the job definition each firing creates a job from." }, - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetWorkflowResultsEndpoint_ResponseOutput" - } - } - ], - "description": "The (possibly capped) list of responses for the rapid." + "revisionNumber": { + "type": "integer", + "description": "Pinned revision number; null means \"latest at fire time\".", + "format": "int32", + "nullable": true }, - "totalResponseCount": { + "intervalSeconds": { "type": "integer", - "description": "The true number of matching responses for this rapid, regardless of whether the\n returned Responses list was capped.", - "format": "int64" + "description": "Seconds between consecutive firings.", + "format": "int32" }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidState" - } - ], - "description": "The state of the rapid." + "nextRunAt": { + "type": "string", + "description": "Timestamp of the next scheduled run.", + "format": "date-time" }, - "context": { + "lastRunAt": { "type": "string", - "description": "The optional textual context of the rapid.", + "description": "Timestamp of the most recent run (null if the signal has never fired).", + "format": "date-time", "nullable": true }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The optional asset shown as context to the user." + "isPaused": { + "type": "boolean", + "description": "Whether the scheduler is currently skipping this signal." }, - "decisiveness": { - "type": "number", - "description": "The decisiveness of the rapid.", - "format": "double", - "nullable": true + "isPublic": { + "type": "boolean", + "description": "Whether the signal is readable by every authenticated user." }, - "aggregation": { - "allOf": [ - { - "$ref": "#/components/schemas/IResponseAggregation" - } - ], - "description": "Per-payload-type aggregation over all matching responses (computed before sampling).\n Populated for Compare and Classify rapids; null otherwise." + "ownerId": { + "type": "string", + "description": "The customer id of the signal owner.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The email of the signal owner." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "When the signal was created.", + "format": "date-time" } } }, - "GetWorkflowResultsEndpoint_PagedResultOfOutput": { + "QuerySignalsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -67394,7 +64292,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetWorkflowResultsEndpoint_Output" + "$ref": "#/components/schemas/QuerySignalsEndpoint_Output" } }, "totalPages": { @@ -67403,571 +64301,711 @@ } } }, - "GetWorkflowResultsEndpoint_ResponseOutput": { + "SignalRunStatus": { + "enum": [ + "Pending", + "Running", + "Completed", + "Failed", + "Skipped" + ] + }, + "SignalRunTriggerSource": { + "enum": [ + "Scheduled", + "Manual" + ] + }, + "TriggerSignalEndpoint_Output": { "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" + "signalId" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" - }, - "age": { + "signalId": { "type": "string", - "nullable": true - }, - "gender": { + "description": "Echoes the signal id; the spawned run is created asynchronously." + } + } + }, + "UpdateSignalEndpoint_Input": { + "type": "object", + "properties": { + "name": { "type": "string", - "nullable": true + "description": "The new name of the signal." }, - "occupation": { + "description": { "type": "string", + "description": "The new description; pass null to clear it.", "nullable": true }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } + "intervalSeconds": { + "type": "integer", + "description": "The new cadence in seconds. Minimum 60.", + "format": "int32" } } }, - "IWorkflow": { + "EnsureEnglishEndpoint_Input": { "required": [ - "_t" + "text" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IWorkflowEvaluationWorkflow" - }, - { - "$ref": "#/components/schemas/IWorkflowGroupedRankingWorkflow" - }, - { - "$ref": "#/components/schemas/IWorkflowRankingWorkflow" - }, - { - "$ref": "#/components/schemas/IWorkflowSimpleWorkflow" + "properties": { + "text": { + "type": "string", + "description": "The text to ensure is English." } + } + }, + "EnsureEnglishEndpoint_Output": { + "required": [ + "englishText" ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "EvaluationWorkflow": "#/components/schemas/IWorkflowEvaluationWorkflow", - "GroupedRankingWorkflowModel": "#/components/schemas/IWorkflowGroupedRankingWorkflow", - "RankingWorkflowModel": "#/components/schemas/IWorkflowRankingWorkflow", - "SimpleWorkflowModel": "#/components/schemas/IWorkflowSimpleWorkflow" + "type": "object", + "properties": { + "englishText": { + "type": "string", + "description": "The English version of the provided text." } } }, - "IWorkflowEvaluationWorkflow": { + "TranslateEndpoint_Input": { "required": [ - "id", - "validationSetId", - "state", - "referee", - "name", - "ownerMail", - "organizationId", - "_t" + "translator", + "text", + "targetLanguage" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "EvaluationWorkflow" + "translator": { + "allOf": [ + { + "$ref": "#/components/schemas/TranslatorType" + } ], - "type": "string" - }, - "id": { - "type": "string" - }, - "validationSetId": { - "type": "string" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" + "description": "The type of translator to use." }, - "name": { - "type": "string" + "text": { + "type": "string", + "description": "The text to translate." }, - "ownerMail": { + "targetLanguage": { "type": "string", - "nullable": true + "description": "The language to translate the text into." }, - "organizationId": { - "type": "string" + "sourceLanguage": { + "type": "string", + "description": "The original language of the text." } } }, - "IWorkflowGroupedRankingWorkflow": { + "TranslateEndpoint_Output": { "required": [ - "id", - "referee", - "state", - "criteria", - "name", - "ownerMail", - "organizationId", - "_t" + "translation", + "sourceLanguage", + "targetLanguage" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "GroupedRankingWorkflowModel" - ], - "type": "string" - }, - "id": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "criteria": { - "type": "string" - }, - "name": { - "type": "string" + "translation": { + "type": "string", + "description": "The translated text." }, - "ownerMail": { + "sourceLanguage": { "type": "string", + "description": "The detected or provided source language of the text.", "nullable": true }, - "organizationId": { - "type": "string" - }, - "rankingConfig": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRankingConfig" - } - ], - "nullable": true + "targetLanguage": { + "type": "string", + "description": "The language the text was translated into." } } }, - "IWorkflowRankingWorkflow": { + "TranslatorType": { + "enum": [ + "Google", + "Deepl", + "OpenAi", + "OpenAi4O", + "OpenAi4OMini", + "LibreTranslate", + "Gemini", + "Tllm" + ] + }, + "AddValidationRapidEndpoint_Input": { "required": [ - "id", - "referee", - "pairMakerInformation", - "state", - "criteria", - "name", - "context", - "contextAsset", - "ownerMail", - "organizationId", - "_t" + "asset", + "payload" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "RankingWorkflowModel" + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } ], - "type": "string" - }, - "id": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "pairMakerInformation": { - "$ref": "#/components/schemas/IPairMakerInformation" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "criteria": { - "type": "string" + "description": "The asset to use for the rapid." }, - "name": { - "type": "string" + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapidPayload" + } + ], + "description": "The payload to use for the rapid." }, - "rankingConfig": { - "type": "object", - "oneOf": [ + "truth": { + "allOf": [ { - "$ref": "#/components/schemas/IRankingConfig" + "$ref": "#/components/schemas/IValidationTruth" } ], + "description": "The ground truth for the rapid." + }, + "randomCorrectProbability": { + "type": "number", + "description": "The probability for an answer to be correct when randomly guessing.", + "format": "double", + "nullable": true + }, + "explanation": { + "type": "string", + "description": "An explanation shown to the users if they answer the rapid incorrectly.", "nullable": true }, "context": { "type": "string", + "description": "An optional textual context that provides additional information to the user about the rapid.", "nullable": true }, "contextAsset": { - "type": "object", - "oneOf": [ + "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/IAssetInput" } ], - "nullable": true - }, - "ownerMail": { - "type": "string", - "nullable": true + "description": "An optional asset that provides additional context to the user about the rapid." }, - "organizationId": { - "type": "string" + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "The feature flags to enable for the rapid." } } }, - "IWorkflowRapidBlueprint": { + "AssetType": { + "type": "array", + "items": { + "enum": [ + "None", + "Image", + "Video", + "Audio", + "Text" + ], + "type": "string" + } + }, + "CreateValidationSetEndpoint_Input": { "required": [ - "_t" + "name" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintLineWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint" + "properties": { + "name": { + "type": "string", + "description": "The name of the validation set." } + } + }, + "CreateValidationSetEndpoint_Output": { + "required": [ + "validationSetId" ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassifyBlueprint": "#/components/schemas/IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint", - "BoundingBoxBlueprint": "#/components/schemas/IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint", - "CompareBlueprint": "#/components/schemas/IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint", - "FreeTextBlueprint": "#/components/schemas/IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint", - "LineBlueprint": "#/components/schemas/IWorkflowRapidBlueprintLineWorkflowRapidBlueprint", - "LocateBlueprint": "#/components/schemas/IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint", - "NamedEntityBlueprint": "#/components/schemas/IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint", - "PolygonBlueprint": "#/components/schemas/IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint", - "ScrubBlueprint": "#/components/schemas/IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint", - "TranscriptionBlueprint": "#/components/schemas/IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint" + "type": "object", + "properties": { + "validationSetId": { + "type": "string", + "description": "The id of the created validation set." } } }, - "IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint": { + "GetAvailableValidationSetsEndpoint_Output": { "required": [ - "categories", - "title", - "_t" + "validationSets" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ClassifyBlueprint" + "validationSets": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutput" + } + } ], + "description": "The validation sets available to the current user's organization." + } + } + }, + "GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutput": { + "required": [ + "id", + "name", + "ownerId" + ], + "type": "object", + "properties": { + "id": { "type": "string" }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachCategoryWorkflowRapidBlueprint_Category" - } - }, - "title": { + "name": { "type": "string" + }, + "ownerId": { + "type": "string", + "format": "uuid" } } }, - "IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint": { + "GetCompatibleValidationSetsEndpoint_Output": { "required": [ - "target", - "_t" + "validationSets" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "BoundingBoxBlueprint" + "validationSets": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetCompatibleValidationSetsEndpoint_ValidationSetOutput" + } + } ], - "type": "string" - }, - "target": { - "type": "string" + "description": "The validation sets that the rapid can be added to." } } }, - "IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint": { + "GetCompatibleValidationSetsEndpoint_ValidationSetOutput": { "required": [ - "criteria", - "indexIdentifiers", - "_t" + "id", + "name", + "assetType", + "modality", + "promptType", + "dimensions", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "CompareBlueprint" - ], + "id": { "type": "string" }, - "criteria": { + "name": { "type": "string" }, - "indexIdentifiers": { + "assetType": { + "$ref": "#/components/schemas/AssetType" + }, + "modality": { + "$ref": "#/components/schemas/RapidModality" + }, + "promptType": { + "$ref": "#/components/schemas/PromptType" + }, + "dimensions": { "type": "array", "items": { "type": "string" - } - } - } - }, - "IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint": { - "required": [ - "question", - "shouldValidateResponse", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FreeTextBlueprint" - ], - "type": "string" - }, - "question": { - "type": "string" + }, + "nullable": true }, - "shouldValidateResponse": { + "isPublic": { "type": "boolean" }, - "validationSystemPrompt": { + "ownerId": { "type": "string", - "nullable": true - } - } - }, - "IWorkflowRapidBlueprintLineWorkflowRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LineBlueprint" - ], + "format": "uuid" + }, + "ownerMail": { "type": "string" }, - "target": { + "organizationId": { "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" } } }, - "IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint": { + "GetRecommendedValidationSetEndpoint_Output": { "required": [ - "target", - "_t" + "validationSets" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LocateBlueprint" + "validationSets": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetRecommendedValidationSetEndpoint_ValidationSetOutput" + } + } ], - "type": "string" - }, - "target": { - "type": "string" + "description": "The validation sets that best match the provided parameters." } } }, - "IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint": { + "GetRecommendedValidationSetEndpoint_ValidationSetOutput": { "required": [ - "target", - "classes", - "_t" + "id", + "name", + "assetType", + "modality", + "promptType", + "dimensions", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NamedEntityBlueprint" - ], + "id": { "type": "string" }, - "target": { + "name": { "type": "string" }, - "classes": { + "assetType": { + "$ref": "#/components/schemas/AssetType" + }, + "modality": { + "$ref": "#/components/schemas/RapidModality" + }, + "promptType": { + "$ref": "#/components/schemas/PromptType" + }, + "dimensions": { "type": "array", "items": { "type": "string" - } - } - } - }, - "IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonBlueprint" - ], + }, + "nullable": true + }, + "isPublic": { + "type": "boolean" + }, + "ownerId": { + "type": "string", + "format": "uuid" + }, + "ownerMail": { "type": "string" }, - "target": { + "organizationId": { "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" } } }, - "IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint": { + "GetValidationRapidsEndpoint_Output": { "required": [ - "target", - "_t" + "id", + "type", + "asset", + "payload", + "correctValidationCount", + "invalidValidationCount", + "state" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ScrubBlueprint" + "id": { + "type": "string", + "description": "The unique identifier of the rapid." + }, + "type": { + "type": "string", + "description": "The type of the rapid." + }, + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } ], - "type": "string" + "description": "The asset associated with the rapid." }, - "target": { - "type": "string" + "truth": { + "allOf": [ + { + "$ref": "#/components/schemas/IValidationTruth" + } + ], + "description": "The truth of the rapid." + }, + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapidPayload" + } + ], + "description": "The payload of the rapid." + }, + "context": { + "type": "string", + "description": "The optional textual context of the rapid.", + "nullable": true + }, + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The optional asset shown as context to the user." + }, + "correctValidationCount": { + "type": "integer", + "description": "The number of correct validations received.", + "format": "int32" + }, + "invalidValidationCount": { + "type": "integer", + "description": "The number of invalid validations received.", + "format": "int32" + }, + "explanation": { + "type": "string", + "description": "The explanation shown when users answer incorrectly.", + "nullable": true + }, + "randomCorrectProbability": { + "type": "number", + "description": "The probability of a random correct answer.", + "format": "double", + "nullable": true + }, + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/RapidState" + } + ], + "description": "The state of the rapid." } } }, - "IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint": { + "GetValidationRapidsEndpoint_PagedResultOfOutput": { "required": [ - "title", - "_t" + "total", + "page", + "pageSize", + "items" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "TranscriptionBlueprint" - ], - "type": "string" + "total": { + "type": "integer", + "format": "int64" }, - "title": { - "type": "string" + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetValidationRapidsEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "IWorkflowSimpleWorkflow": { + "GetValidationSetByIdEndpoint_Output": { "required": [ "id", - "state", - "blueprint", - "referee", "name", + "isPublic", "ownerMail", "organizationId", - "_t" + "ownerId", + "dimensions", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "SimpleWorkflowModel" - ], - "type": "string" - }, "id": { - "type": "string" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "blueprint": { - "$ref": "#/components/schemas/IWorkflowRapidBlueprint" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" + "type": "string", + "description": "The unique identifier of the validation set." }, "name": { - "type": "string" + "type": "string", + "description": "The name of the validation set." + }, + "isPublic": { + "type": "boolean", + "description": "Whether the validation set is public." }, "ownerMail": { "type": "string", - "nullable": true + "description": "The mail of the owning customer." }, "organizationId": { - "type": "string" + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "ownerId": { + "type": "string", + "description": "The id of the owning customer.", + "format": "uuid" + }, + "dimensions": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The dimensions shared across all rapids in the validation set." + }, + "createdAt": { + "type": "string", + "description": "The time at which the validation set was created.", + "format": "date-time" } } }, - "QueryWorkflowsEndpoint_Output": { + "PromptType": { + "type": "array", + "items": { + "enum": [ + "None", + "Text", + "Asset" + ], + "type": "string" + } + }, + "QueryValidationSetsEndpoint_Output": { "required": [ - "workflow" + "id", + "name", + "assetType", + "modality", + "promptType", + "dimensions", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], "type": "object", "properties": { - "workflow": { + "id": { + "type": "string", + "description": "The unique identifier of the validation set." + }, + "name": { + "type": "string", + "description": "The name of the validation set." + }, + "assetType": { + "allOf": [ + { + "$ref": "#/components/schemas/AssetType" + } + ], + "description": "The asset types contained in the validation set." + }, + "modality": { + "allOf": [ + { + "$ref": "#/components/schemas/RapidModality" + } + ], + "description": "The rapid modalities contained in the validation set." + }, + "promptType": { + "allOf": [ + { + "$ref": "#/components/schemas/PromptType" + } + ], + "description": "The prompt types contained in the validation set." + }, + "dimensions": { "allOf": [ { - "$ref": "#/components/schemas/IWorkflow" + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } ], - "description": "The workflow." + "description": "The dimensions shared across all rapids in the validation set." + }, + "isPublic": { + "type": "boolean", + "description": "Whether the validation set is public." + }, + "ownerId": { + "type": "string", + "description": "The id of the owning customer.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The mail of the owning customer." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "The time at which the validation set was created.", + "format": "date-time" } } }, - "QueryWorkflowsEndpoint_PagedResultOfOutput": { + "QueryValidationSetsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -67991,7 +65029,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryWorkflowsEndpoint_Output" + "$ref": "#/components/schemas/QueryValidationSetsEndpoint_Output" } }, "totalPages": { @@ -68000,15 +65038,87 @@ } } }, - "WorkflowState": { - "enum": [ - "Created", - "Started", - "Labeling", - "Paused", - "Done", - "Failed" - ] + "RapidModality": { + "type": "array", + "items": { + "enum": [ + "None", + "BoundingBox", + "Classify", + "Compare", + "FreeText", + "Line", + "Locate", + "NamedEntity", + "Polygon", + "Scrub", + "Transcription" + ], + "type": "string" + } + }, + "UpdateValidationSetDimensionsEndpoint_Input": { + "required": [ + "dimensions" + ], + "type": "object", + "properties": { + "dimensions": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The dimensions to set on all rapids within the validation set." + } + } + }, + "UpdateValidationSetEndpoint_Input": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The new name of the validation set." + }, + "dimensions": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The new dimensions of the validation set." + }, + "shouldAlert": { + "type": "boolean", + "description": "Whether users should be alerted if they answer incorrectly." + }, + "isPublic": { + "type": "boolean", + "description": "Whether the validation set should be public." + }, + "isFlagOverruled": { + "type": "boolean", + "description": "Whether flags on validation rapids should be overruled." + } + } + }, + "UpdateValidationSetShouldAlertEndpoint_Input": { + "required": [ + "shouldAlert" + ], + "type": "object", + "properties": { + "shouldAlert": { + "type": "boolean", + "description": "A flag indicating whether users should be alerted if they answer incorrectly." + } + } } }, "securitySchemes": { @@ -68113,12 +65223,6 @@ "Payment" ] }, - { - "name": "Rapidata Pipeline API", - "tags": [ - "Pipeline" - ] - }, { "name": "Rapidata Rapid API", "tags": [ @@ -68146,16 +65250,6 @@ "tags": [ "ValidationSet" ] - }, - { - "name": "Rapidata Workflow API", - "tags": [ - "Evaluation", - "GroupedRanking", - "Ranking", - "SimpleWorkflow", - "Workflow" - ] } ] } diff --git a/openapi/schemas/rapidata.openapi.json b/openapi/schemas/rapidata.openapi.json index d8b45514af..26fc0cd3d2 100644 --- a/openapi/schemas/rapidata.openapi.json +++ b/openapi/schemas/rapidata.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Asset API", "description": "The API for the Rapidata Asset service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { @@ -203,10 +203,6 @@ "name": "Payment", "x-displayName": "Payment" }, - { - "name": "Pipeline", - "x-displayName": "Pipeline" - }, { "name": "CustomerRapid", "x-displayName": "CustomerRapid" @@ -238,26 +234,6 @@ { "name": "ValidationSet", "x-displayName": "ValidationSet" - }, - { - "name": "Evaluation", - "x-displayName": "Evaluation" - }, - { - "name": "GroupedRanking", - "x-displayName": "GroupedRanking" - }, - { - "name": "Ranking", - "x-displayName": "Ranking" - }, - { - "name": "SimpleWorkflow", - "x-displayName": "SimpleWorkflow" - }, - { - "name": "Workflow", - "x-displayName": "Workflow" } ], "paths": { @@ -36072,30 +36048,30 @@ ] } }, - "/pipeline/{pipelineId}": { - "get": { + "/rapid/demographic": { + "post": { "tags": [ - "Pipeline" + "CustomerRapid" ], - "summary": "Gets a pipeline by its id.", - "parameters": [ - { - "name": "pipelineId", - "in": "path", - "description": "The id of the pipeline to get.", - "required": true, - "schema": { - "type": "string" + "summary": "Creates a new demographic rapid.", + "requestBody": { + "description": "The demographic rapid payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Input" + } } - } - ], + }, + "required": true + }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPipelineByIdEndpoint_Output" + "$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Output" } } } @@ -36117,7 +36093,6 @@ "description": "Forbidden" } }, - "deprecated": true, "security": [ { "OpenIdConnect": [ @@ -36130,38 +36105,73 @@ ] } }, - "/pipeline/preliminary-download/{preliminaryDownloadId}": { - "get": { + "/rapid/{rapidId}": { + "delete": { "tags": [ - "Pipeline" + "CustomerRapid" ], - "summary": "Streams the preliminary download file when ready.", - "description": "Returns 202 while the download is still processing.", + "summary": "Deletes a rapid.", "parameters": [ { - "name": "preliminaryDownloadId", + "name": "rapidId", "in": "path", - "description": "The id of the preliminary download to get.", + "description": "The id of the rapid to delete.", "required": true, "schema": { "type": "string" } } ], + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthenticated" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "OpenIdConnect": [ + "openid", + "profile", + "email", + "offline_access" + ] + } + ] + } + }, + "/rapid/global-responses": { + "get": { + "tags": [ + "CustomerRapid" + ], + "summary": "Gets the most recent public responses across all customers.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output" } } } }, - "202": { - "description": "Accepted" - }, "400": { "description": "Bad Request", "content": { @@ -36191,41 +36201,30 @@ ] } }, - "/pipeline/{pipelineId}/preliminary-download": { - "post": { + "/rapid/{rapidId}/responses": { + "get": { "tags": [ - "Pipeline" + "CustomerRapid" ], - "summary": "Initiates a preliminary download of the pipeline.", + "summary": "Gets all responses for a given rapid.", "parameters": [ { - "name": "pipelineId", + "name": "rapidId", "in": "path", - "description": "The id of the pipeline to initiate the download for.", + "description": "The rapid to get the responses for.", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "description": "Whether to email the caller when the download is ready.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StartPreliminaryDownloadEndpoint_Input" - } - } - }, - "required": true - }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StartPreliminaryDownloadEndpoint_Output" + "$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output" } } } @@ -36259,524 +36258,314 @@ ] } }, - "/rapid/demographic": { - "post": { + "/rapids/flagged": { + "get": { "tags": [ "CustomerRapid" ], - "summary": "Creates a new demographic rapid.", - "requestBody": { - "description": "The demographic rapid payload.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Input" + "summary": "Queries all rapids that have been flagged.", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "The 1-based page index.", + "schema": { + "type": "integer" + }, + "x-parameter-group": "page" + }, + { + "name": "page_size", + "in": "query", + "description": "The number of items per page.", + "schema": { + "type": "integer" + }, + "x-parameter-group": "page" + }, + { + "name": "sort", + "in": "query", + "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", + "schema": { + "type": "array", + "items": { + "enum": [ + "id", + "-id", + "completed_at", + "-completed_at" + ], + "type": "string" } - } + }, + "x-parameter-group": "sort" }, - "required": true - }, + { + "name": "id", + "in": "query", + "description": "Filter by id.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "correlation_id", + "in": "query", + "description": "Filter by correlation_id.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "owner_id", + "in": "query", + "description": "Filter by owner_id.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "key", + "in": "query", + "description": "Filter by key.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "completed_at", + "in": "query", + "description": "Filter by completed_at.", + "style": "deepObject", + "explode": true, + "schema": { + "type": "object", + "properties": { + "eq": { + "type": "string" + }, + "neq": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "gte": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "starts_with": { + "type": "string" + }, + "ends_with": { + "type": "string" + }, + "in": { + "type": "array", + "items": { + "type": "string" + } + }, + "not_contains": { + "type": "string" + } + } + }, + "x-parameter-group": "filters" + }, + { + "name": "logic", + "in": "query", + "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", + "schema": { + "enum": [ + "and", + "or" + ], + "type": "string" + } + } + ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateDemographicRapidEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/rapid/{rapidId}": { - "delete": { - "tags": [ - "CustomerRapid" - ], - "summary": "Deletes a rapid.", - "parameters": [ - { - "name": "rapidId", - "in": "path", - "description": "The id of the rapid to delete.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/rapid/global-responses": { - "get": { - "tags": [ - "CustomerRapid" - ], - "summary": "Gets the most recent public responses across all customers.", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/rapid/{rapidId}/responses": { - "get": { - "tags": [ - "CustomerRapid" - ], - "summary": "Gets all responses for a given rapid.", - "parameters": [ - { - "name": "rapidId", - "in": "path", - "description": "The rapid to get the responses for.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/rapids/flagged": { - "get": { - "tags": [ - "CustomerRapid" - ], - "summary": "Queries all rapids that have been flagged.", - "parameters": [ - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "id", - "-id", - "completed_at", - "-completed_at" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - }, - { - "name": "id", - "in": "query", - "description": "Filter by id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "correlation_id", - "in": "query", - "description": "Filter by correlation_id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "owner_id", - "in": "query", - "description": "Filter by owner_id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "key", - "in": "query", - "description": "Filter by key.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "completed_at", - "in": "query", - "description": "Filter by completed_at.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "logic", - "in": "query", - "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", - "schema": { - "enum": [ - "and", - "or" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_PagedResultOfOutput" + "$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_PagedResultOfOutput" } } } @@ -41163,4009 +40952,359 @@ } ] } - }, - "/workflow/evaluation/{workflowId}/results": { - "get": { - "tags": [ - "Evaluation" - ], - "summary": "Gets the results for an evaluation workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the results for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "states", - "in": "query", - "description": "Optional list of rapid states to filter by. If not provided, all states are included.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RapidState" - } - } - }, - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "id", - "-id" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetWorkflowResultsEndpoint_PagedResultOfOutput" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflow/grouped-ranking/{workflowId}/results": { - "get": { - "tags": [ - "GroupedRanking" - ], - "summary": "Gets the result overview for a grouped ranking workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the results for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "name", - "-name", - "state", - "-state", - "created_at", - "-created_at" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - }, - { - "name": "id", - "in": "query", - "description": "Filter by id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "name", - "in": "query", - "description": "Filter by name.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "state", - "in": "query", - "description": "Filter by state.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "logic", - "in": "query", - "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", - "schema": { - "enum": [ - "and", - "or" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetGroupedRankingWorkflowResultsEndpoint_PagedResultOfOutput" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflow/compare/{workflowId}/results": { - "get": { - "tags": [ - "Ranking" - ], - "summary": "Gets the result overview for a ranking workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the results for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "id", - "-id", - "score", - "-score" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetRankingWorkflowResultsEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflow/simple/{workflowId}/results": { - "get": { - "tags": [ - "SimpleWorkflow" - ], - "summary": "Gets the result overview for a simple workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the results for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "states", - "in": "query", - "description": "Optional list of rapid states to include in the results.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RapidState" - } - } - }, - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "id", - "-id", - "state", - "-state", - "decisiveness", - "-decisiveness", - "accepted_response_count", - "-accepted_response_count", - "has_responses", - "-has_responses" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_PagedResultOfOutput" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflow/{workflowId}": { - "delete": { - "tags": [ - "Workflow" - ], - "summary": "Deletes a workflow by its id.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to delete.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - }, - "get": { - "tags": [ - "Workflow" - ], - "summary": "Returns the workflow identified by workflowId.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "Identifier of the workflow to fetch.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetWorkflowByIdEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflow/{workflowId}/compare-ab-summary": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Returns the number of times each asset index won across the workflow's rapids.", - "description": "The entries of winCounter are ordered by compared side: the first is the first\n compared side, the second is the second, and so on. That order is the order of the\n workflow's compare blueprint, which is also the order the sides' assets appear in on every\n rapid returned by /workflow/simple/{workflowId}/results — so rendering the entries\n as they arrive lines up with the individual rapids. Sides that have not won a rapid yet\n are present with a count of 0.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the summary for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "useUserScore", - "in": "query", - "description": "Whether to use the user score to determine the winner.", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCompareAbSummaryEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflow/{workflowId}/progress": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Gets the progress of a workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the progress for.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetWorkflowProgressEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflow/{workflowId}/responses": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Gets the most recent or oldest responses for a workflow, across any rapid.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the responses for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "The maximum number of responses to return.", - "schema": { - "type": "integer", - "format": "int32", - "default": 100 - } - }, - { - "name": "sort", - "in": "query", - "description": "Whether the oldest or most recent responses should be returned.", - "schema": { - "$ref": "#/components/schemas/SortDirection" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetWorkflowResponsesEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - }, - "/workflows": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Queries workflows based on the provided filter, page, and sort criteria.", - "parameters": [ - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "name", - "-name", - "state", - "-state", - "created_at", - "-created_at" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - }, - { - "name": "id", - "in": "query", - "description": "Filter by id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "name", - "in": "query", - "description": "Filter by name.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "state", - "in": "query", - "description": "Filter by state.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "owner_mail", - "in": "query", - "description": "Filter by owner_mail.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "logic", - "in": "query", - "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", - "schema": { - "enum": [ - "and", - "or" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QueryWorkflowsEndpoint_PagedResultOfOutput" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] - } - } - }, - "components": { - "schemas": { - "BatchUploadStatus": { - "enum": [ - "Processing", - "Completed", - "Aborted" - ] - }, - "BatchUploadUrlStatus": { - "enum": [ - "Pending", - "Completed", - "Failed" - ] - }, - "CompressionOverride": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "nullable": true - }, - "quality": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "maxDimension": { - "type": "integer", - "format": "int32", - "nullable": true - } - } - }, - "CreateBatchUploadEndpoint_Input": { - "required": [ - "urls" - ], - "type": "object", - "properties": { - "urls": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string", - "format": "uri" - } - } - ], - "description": "The URLs to download and process." - }, - "correlationId": { - "type": "string", - "description": "Optional client-supplied identifier to group related batch uploads.", - "nullable": true - }, - "compression": { - "allOf": [ - { - "$ref": "#/components/schemas/CompressionOverride" - } - ], - "description": "Optional per-call override for image compression applied to every URL in the batch.\n Null means use the configured defaults." - } - } - }, - "CreateBatchUploadEndpoint_Output": { - "required": [ - "batchUploadId" - ], - "type": "object", - "properties": { - "batchUploadId": { - "type": "string", - "description": "The identifier of the created batch upload." - } - } - }, - "GetBatchUploadResultEndpoint_Output": { - "required": [ - "batchUploadId", - "status", - "totalCount", - "completedCount", - "failedCount", - "items" - ], - "type": "object", - "properties": { - "batchUploadId": { - "type": "string", - "description": "The identifier of the batch upload." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/BatchUploadStatus" - } - ], - "description": "The current status of the batch upload." - }, - "totalCount": { - "type": "integer", - "description": "The total number of URLs in the batch.", - "format": "int32" - }, - "completedCount": { - "type": "integer", - "description": "The number of URLs that have been successfully processed.", - "format": "int32" - }, - "failedCount": { - "type": "integer", - "description": "The number of URLs that failed to process.", - "format": "int32" - }, - "items": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBatchUploadResultEndpoint_UrlOutput" - } - } - ], - "description": "The individual results for each URL in the batch." - } - } - }, - "GetBatchUploadResultEndpoint_UrlOutput": { - "required": [ - "url", - "status" - ], - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "fileName": { - "type": "string", - "nullable": true - }, - "warnings": { - "type": "array", - "items": { - "type": "string" - } - }, - "status": { - "$ref": "#/components/schemas/BatchUploadUrlStatus" - }, - "errorMessage": { - "type": "string", - "nullable": true - }, - "stage": { - "type": "string", - "nullable": true - }, - "upstreamHttpStatus": { - "type": "integer", - "format": "int32", - "nullable": true - } - } - }, - "GetBatchUploadStatusEndpoint_Output": { - "required": [ - "status", - "totalCount", - "completedCount", - "failedCount", - "completedBatches" - ], - "type": "object", - "properties": { - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/BatchUploadStatus" - } - ], - "description": "The aggregated status across all queried batch uploads." - }, - "totalCount": { - "type": "integer", - "description": "The total number of URLs across all queried batches.", - "format": "int32" - }, - "completedCount": { - "type": "integer", - "description": "The number of URLs that have been successfully processed.", - "format": "int32" - }, - "failedCount": { - "type": "integer", - "description": "The number of URLs that failed to process.", - "format": "int32" - }, - "completedBatches": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The identifiers of batch uploads that have fully completed." - } - } - }, - "IFormFile": { - "type": "string", - "format": "binary" - }, - "UploadFileEndpoint_Output": { - "required": [ - "fileName", - "warnings", - "wasCompressed" - ], - "type": "object", - "properties": { - "fileName": { - "type": "string", - "description": "The generated file name used internally to reference the uploaded asset.\n This is not the original file name and should be used for all subsequent operations on this asset." - }, - "warnings": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Any warnings that might have occurred during the upload." - }, - "wasCompressed": { - "type": "boolean", - "description": "Whether the uploaded file was compressed during processing." - }, - "originalSizeBytes": { - "type": "integer", - "description": "The original size of the uploaded file in bytes, if available. This may be null if the size could not be determined.", - "format": "int64", - "nullable": true - }, - "finalSizeBytes": { - "type": "integer", - "description": "The final size of the stored file in bytes after processing (e.g., compression), if available.\n This may be null if the size could not be determined. If compression was applied, this size may be smaller than the original size.", - "format": "int64", - "nullable": true - } - } - }, - "UploadFileFromUrlEndpoint_Output": { - "required": [ - "fileName", - "warnings", - "wasCompressed" - ], - "type": "object", - "properties": { - "fileName": { - "type": "string", - "description": "The generated file name used internally to reference the uploaded asset.\n This is not the original file name and should be used for all subsequent operations on this asset." - }, - "warnings": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Any warnings that might have occurred during the upload." - }, - "wasCompressed": { - "type": "boolean", - "description": "Whether the uploaded file was compressed during processing." - }, - "originalSizeBytes": { - "type": "integer", - "description": "The original size of the uploaded file in bytes, if available. This may be null if the size could not be determined.", - "format": "int64", - "nullable": true - }, - "finalSizeBytes": { - "type": "integer", - "description": "The final size of the stored file in bytes after processing (e.g., compression), if available.\n This may be smaller than the original size if compression was applied.", - "format": "int64", - "nullable": true - } - } - }, - "ValidationProblemDetails": { - "type": "object", - "properties": { - "type": { - "type": "string", - "nullable": true - }, - "title": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "instance": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "AddExampleToAudienceEndpoint_Input": { - "required": [ - "asset", - "payload", - "randomCorrectProbability" - ], - "type": "object", - "properties": { - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "The asset to use for the example." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IExamplePayload" - } - ], - "description": "The payload to use for the example." - }, - "truth": { - "allOf": [ - { - "$ref": "#/components/schemas/IExampleTruth" - } - ], - "description": "The ground truth for the example." - }, - "randomCorrectProbability": { - "type": "number", - "description": "The probability for an answer to be correct when randomly guessing.", - "format": "double" - }, - "explanation": { - "type": "string", - "description": "An explanation for the users if they answer the example incorrectly.", - "nullable": true - }, - "context": { - "type": "string", - "description": "An optional textual context that provides additional information to the user.", - "nullable": true - }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "An optional asset that provides additional context to the user." - }, - "sortIndex": { - "type": "integer", - "description": "The sort index that controls the serving order of this example within the audience.\n When null, the next sort index is automatically calculated.", - "format": "int32", - "nullable": true - }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - ], - "description": "The feature flags to enable for the example." - }, - "isCommonSense": { - "type": "boolean", - "description": "Whether this example should be treated as commonsense validation.\n When true, incorrect answers are not accepted and the example affects global score.\n When null, AI auto-detection will determine if the example is common sense.", - "nullable": true - }, - "visibility": { - "allOf": [ - { - "$ref": "#/components/schemas/ExampleVisibility" - } - ], - "description": "Controls who can see this example. Public examples are visible to all customers.\n Private examples are only visible to the customer who created them and admins.\n Defaults to Private." - } - }, - "description": "Input model for adding an example to an audience." - }, - "AddExampleToAudienceEndpoint_Output": { - "type": "object", - "properties": { - "recalculationId": { - "type": "string", - "description": "The id of the audience state recalculation dispatched as a result of adding this example.\n Null when the example addition cannot transition any user's state (e.g. the audience\n already has more examples than MaxDistillingResponses + 1).", - "nullable": true - } - } - }, - "AudienceInactivitySyncPhase": { - "enum": [ - "MarkingInactiveUsers", - "Finalizing", - "Done" - ] - }, - "AudienceInactivitySyncState": { - "enum": [ - "Pending", - "Processing", - "Completed", - "Failed", - "Aborted" - ] - }, - "AudienceJobState": { - "enum": [ - "Submitted", - "Running", - "Completed", - "Failed", - "ManualApproval", - "Queued", - "Paused", - "StaleResults", - "SpendLimited" - ] - }, - "AudienceStateRecalculationPhase": { - "enum": [ - "RecalculatingUsers", - "Finalizing", - "Done" - ] - }, - "AudienceStateRecalculationState": { - "enum": [ - "Pending", - "Processing", - "Completed", - "Failed", - "Aborted" - ] - }, - "AudienceStatus": { - "enum": [ - "Created", - "Pending", - "Recruiting", - "Ready" - ] - }, - "BoostLevel": { - "enum": [ - "None", - "Stable", - "Distilling", - "Global" - ] - }, - "ChangeAudienceOwnerEndpoint_Input": { - "required": [ - "ownerId", - "ownerMail" - ], - "type": "object", - "properties": { - "ownerId": { - "type": "string", - "description": "The unique identifier of the new owner.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The email address of the new owner." - } - } - }, - "CreateAudienceEndpoint_Input": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name to give the newly created audience." - }, - "description": { - "type": "string", - "description": "An optional markdown-supported description of the audience's purpose.", - "nullable": true - }, - "filters": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IAudienceFilter" - }, - "nullable": true - } - ], - "description": "The filters to apply to any orders created for this audience.\n A filter can be used to restrict the audience to a specific subset of users." - }, - "graduationRule": { - "allOf": [ - { - "$ref": "#/components/schemas/IGraduationRule" - } - ], - "description": "How users graduate into this audience — either a score-threshold rule or a\n task-accuracy rule (\"solve N tasks at X accuracy\"). When omitted, new audiences\n default to a task-accuracy rule (0.75 accuracy over 10 tasks)." - }, - "minimumSizeForActivation": { - "type": "integer", - "description": "The minimum number of users required for an audience to be activated.", - "format": "int64", - "nullable": true - }, - "logo": { - "allOf": [ - { - "$ref": "#/components/schemas/ExistingAssetInput" - } - ], - "description": "An optional logo image for the audience. Must be an existing image asset." - }, - "maxDistillingResponses": { - "type": "integer", - "description": "Maximum responses before user exits the distilling campaign.\n Defaults to 10. Set to null to disable this exit condition.", - "format": "uint32", - "nullable": true - }, - "dropMinResponses": { - "type": "integer", - "description": "Minimum responses before the drop score check applies.\n Users need at least this many responses before they can be kicked out for low score.\n Defaults to 3. Set to null to apply drop score check from the first response.", - "format": "uint32", - "nullable": true - }, - "dropScore": { - "type": "number", - "description": "Score floor - users below this score exit the distilling campaign\n (only after completing DropMinResponses).\n Defaults to 0.2. Set to null to disable this exit condition.", - "format": "double", - "nullable": true - }, - "isDistillingCampaignSticky": { - "type": "boolean", - "description": "Whether the distilling campaign should be sticky (users stay until filters don't match).\n Defaults to true (Temporary sticky)." - }, - "maxDistillingSessions": { - "type": "integer", - "description": "Maximum sessions (rapid retrievals) before user exits the distilling campaign.\n Defaults to null (disabled). Set to a value to enable session-based exit condition.", - "format": "uint32", - "nullable": true - }, - "inactivityDropDays": { - "type": "integer", - "description": "Number of days of inactivity before a distilling user is dropped.\n Defaults to null (disabled).", - "format": "uint32", - "nullable": true - }, - "minSubmissionRate": { - "type": "number", - "description": "Minimum submission rate (responses / sessions) before a user is dropped.\n Defaults to null (disabled).", - "format": "double", - "nullable": true - }, - "minSessionsForSubmissionRate": { - "type": "integer", - "description": "Minimum number of sessions before the submission rate check applies.\n Defaults to null (applies from first session).", - "format": "uint32", - "nullable": true - }, - "minSubmissionRateGraduated": { - "type": "number", - "description": "Minimum submission rate for graduated users. If null, MinSubmissionRate applies to graduated users.\n Set a lower value to be more lenient with graduated users.", - "format": "double", - "nullable": true - }, - "distillingRetrievalMode": { - "allOf": [ - { - "$ref": "#/components/schemas/RetrievalMode" - } - ], - "description": "The retrieval mode used by the distilling campaign to select rapids for users.\n Defaults to Shuffled." - }, - "minDistillingForGlobalBoost": { - "type": "integer", - "description": "Minimum distilling users before disabling global boost.\n Defaults to 200. Admin-only override.", - "format": "int32", - "nullable": true - }, - "minGraduatedForDistillingBoost": { - "type": "integer", - "description": "Minimum graduated users before disabling distilling boost.\n Defaults to 100. Admin-only override.", - "format": "int32", - "nullable": true - } - } - }, - "CreateAudienceEndpoint_Output": { - "required": [ - "audienceId" - ], - "type": "object", - "properties": { - "audienceId": { - "type": "string", - "description": "The unique identifier of the newly created audience." - } - } - }, - "CreateFilteredAudienceEndpoint_Input": { - "required": [ - "filter" - ], - "type": "object", - "properties": { - "filter": { - "allOf": [ - { - "$ref": "#/components/schemas/IAudienceFilter" - } - ], - "description": "The filter that restricts the base audience's graduates to a subset (e.g. by language,\n country or demographic value). Multiple criteria can be combined with And / Or / Not." - } - } - }, - "CreateFilteredAudienceEndpoint_Output": { - "required": [ - "audienceId" - ], - "type": "object", - "properties": { - "audienceId": { - "type": "string", - "description": "The unique identifier of the filtered audience. Use this id in job creation." - } - } - }, - "DeleteAudienceExampleEndpoint_Output": { - "type": "object", - "properties": { - "recalculationId": { - "type": "string", - "description": "The id of the audience state recalculation dispatched as a result of this deletion.\n Null when the deletion cannot transition any user's state (e.g. the audience still has\n more examples than MaxDistillingResponses + 1 after the delete).", - "nullable": true - } - } - }, - "DeviceType": { - "enum": [ - "Unknown", - "Phone", - "Tablet" - ] - }, - "ExampleBoxShape": { - "type": "object", - "properties": { - "xMin": { - "type": "number", - "format": "double", - "nullable": true - }, - "yMin": { - "type": "number", - "format": "double", - "nullable": true - }, - "xMax": { - "type": "number", - "format": "double", - "nullable": true - }, - "yMax": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "ExampleCategory": { - "required": [ - "label", - "value" - ], - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "ExampleScrubRange": { - "required": [ - "start", - "end" - ], - "type": "object", - "properties": { - "start": { - "type": "integer", - "format": "int32" - }, - "end": { - "type": "integer", - "format": "int32" - } - } - }, - "ExampleTranscriptionWord": { - "required": [ - "word", - "wordIndex" - ], - "type": "object", - "properties": { - "word": { - "type": "string" - }, - "wordIndex": { - "type": "integer", - "format": "int32" - } - } - }, - "ExampleVisibility": { - "enum": [ - "Private", - "Public" - ] - }, - "ExistingAssetInput": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "metadata": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/MetadataInputCollection" - } - ], - "nullable": true - }, - "identifier": { - "type": "string", - "nullable": true - } - } - }, - "FeatureFlag": { - "required": [ - "key", - "value" - ], - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "FileType": { - "enum": [ - "Unknown", - "Image", - "Video", - "Audio" - ] - }, - "GetAudienceByIdEndpoint_Output": { - "required": [ - "id", - "baseAudienceId", - "name", - "status", - "qualifiedUserCount", - "filters", - "createdAt", - "ownerId", - "ownerMail", - "organizationId", - "isPublic", - "isDistilling", - "distillingCampaignId", - "graduationRule", - "distillingRetrievalMode", - "boostLevel" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the audience." - }, - "baseAudienceId": { - "type": "string", - "description": "The audience that backs this entry. Equals id for a regular audience; for a\n filtered audience it points to the audience the filter is applied on top of." - }, - "filter": { - "allOf": [ - { - "$ref": "#/components/schemas/IAudienceFilter" - } - ], - "description": "The filter applied on top of the base audience. Null for a regular audience — a\n non-null value is the sole signal that this is a filtered view. Every other field\n describes the base audience, since a filtered view inherits its configuration and has\n no user counts of its own." - }, - "name": { - "type": "string", - "description": "The name of the audience." - }, - "description": { - "type": "string", - "description": "The markdown-supported description of the audience.", - "nullable": true - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceStatus" - } - ], - "description": "The current status of the audience." - }, - "qualifiedUserCount": { - "type": "integer", - "description": "The number of users that have qualified for this audience.", - "format": "int64" - }, - "filters": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IAudienceFilter" - } - } - ], - "description": "The filters applied to this audience." - }, - "logo": { - "type": "string", - "description": "The URL of the audience logo, if any.", - "nullable": true - }, - "createdAt": { - "type": "string", - "description": "The timestamp when the audience was created.", - "format": "date-time" - }, - "ownerId": { - "type": "string", - "description": "The unique identifier of the audience owner.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The email of the audience owner." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the audience is publicly visible." - }, - "isDistilling": { - "type": "boolean", - "description": "Whether the audience is currently distilling users." - }, - "distillingCampaignId": { - "type": "string", - "description": "The id of the distilling campaign associated with the audience." - }, - "minGraduatedForDistillingBoost": { - "type": "integer", - "description": "Minimum graduated users before disabling distilling boost.", - "format": "int32", - "nullable": true - }, - "minDistillingForGlobalBoost": { - "type": "integer", - "description": "Minimum distilling users before disabling global boost.", - "format": "int32", - "nullable": true - }, - "graduationRule": { - "allOf": [ - { - "$ref": "#/components/schemas/IGraduationRule" - } - ], - "description": "The rule this audience uses to graduate users — a score-threshold rule or a\n task-accuracy rule." - }, - "maxDistillingResponses": { - "type": "integer", - "description": "Maximum responses before user exits the distilling campaign.", - "format": "uint32", - "nullable": true - }, - "dropMinResponses": { - "type": "integer", - "description": "Minimum responses before the drop score check applies.", - "format": "uint32", - "nullable": true - }, - "dropScore": { - "type": "number", - "description": "Score floor - users below this score exit the distilling campaign.", - "format": "double", - "nullable": true - }, - "maxDistillingSessions": { - "type": "integer", - "description": "Maximum sessions before user exits the distilling campaign.", - "format": "uint32", - "nullable": true - }, - "inactivityDropDays": { - "type": "integer", - "description": "Number of days of inactivity before a distilling user is dropped.", - "format": "uint32", - "nullable": true - }, - "minSubmissionRate": { - "type": "number", - "description": "Minimum submission rate before a user is dropped.", - "format": "double", - "nullable": true - }, - "minSessionsForSubmissionRate": { - "type": "integer", - "description": "Minimum number of sessions before the submission rate check applies.", - "format": "uint32", - "nullable": true - }, - "minSubmissionRateGraduated": { - "type": "number", - "description": "Minimum submission rate for graduated users.", - "format": "double", - "nullable": true - }, - "distillingRetrievalMode": { - "allOf": [ - { - "$ref": "#/components/schemas/RetrievalMode" - } - ], - "description": "The retrieval mode used by the distilling campaign to select rapids for users." - }, - "boostLevel": { - "allOf": [ - { - "$ref": "#/components/schemas/BoostLevel" - } - ], - "description": "The current boost level applied to the audience." - }, - "randomAdmissionProbability": { - "type": "number", - "description": "The probability of admitting a random user to the audience.", - "format": "double", - "nullable": true - }, - "health": { - "type": "number", - "description": "The health score of the audience.", - "format": "double", - "nullable": true - }, - "graduated": { - "type": "integer", - "description": "The number of graduated users.", - "format": "int64" - }, - "dropped": { - "type": "integer", - "description": "The number of dropped users.", - "format": "int64" - } - } - }, - "GetAudienceInactivitySyncByIdEndpoint_Output": { - "required": [ - "id", - "audienceId", - "state", - "phase", - "cutoff", - "processedCount", - "changedCount", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the inactivity sync." - }, - "audienceId": { - "type": "string", - "description": "The audience this inactivity sync belongs to." - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceInactivitySyncState" - } - ], - "description": "The current state of the inactivity sync." - }, - "phase": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceInactivitySyncPhase" - } - ], - "description": "The current phase within the inactivity sync lifecycle." - }, - "cutoff": { - "type": "string", - "description": "The cutoff captured at run creation time. Users with last_seen_at older than this are marked inactive.", - "format": "date-time" - }, - "lastProcessedUserId": { - "type": "string", - "description": "The id of the last user that was processed (progress cursor).", - "nullable": true - }, - "processedCount": { - "type": "integer", - "description": "The number of users processed so far.", - "format": "int64" - }, - "changedCount": { - "type": "integer", - "description": "The number of users whose state was changed by the sync.", - "format": "int64" - }, - "errorMessage": { - "type": "string", - "description": "Error message populated when the sync transitioned to Failed.", - "nullable": true - }, - "startedAt": { - "type": "string", - "description": "When the sync began processing (null while still Pending).", - "format": "date-time", - "nullable": true - }, - "lastHeartbeatAt": { - "type": "string", - "description": "Timestamp of the last heartbeat received from the worker.", - "format": "date-time", - "nullable": true - }, - "completedAt": { - "type": "string", - "description": "When the sync reached a terminal state (Completed, Failed, Aborted).", - "format": "date-time", - "nullable": true - }, - "createdAt": { - "type": "string", - "description": "When the sync was created.", - "format": "date-time" - } - } - }, - "GetAudienceStateRecalculationByIdEndpoint_Output": { - "required": [ - "id", - "audienceId", - "state", - "phase", - "processedCount", - "changedCount", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the recalculation." - }, - "audienceId": { - "type": "string", - "description": "The audience this recalculation belongs to." - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceStateRecalculationState" - } - ], - "description": "The current state of the recalculation." - }, - "phase": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceStateRecalculationPhase" - } - ], - "description": "The current phase within the recalculation lifecycle." - }, - "lastProcessedUserId": { - "type": "string", - "description": "The id of the last user that was processed (progress cursor).", - "nullable": true - }, - "processedCount": { - "type": "integer", - "description": "The number of users processed so far.", - "format": "int64" - }, - "changedCount": { - "type": "integer", - "description": "The number of users whose state was changed by the recalculation.", - "format": "int64" - }, - "errorMessage": { - "type": "string", - "description": "Error message populated when the recalculation transitioned to Failed.", - "nullable": true - }, - "startedAt": { - "type": "string", - "description": "When the recalculation began processing (null while still Pending).", - "format": "date-time", - "nullable": true - }, - "lastHeartbeatAt": { - "type": "string", - "description": "Timestamp of the last heartbeat received from the worker.", - "format": "date-time", - "nullable": true - }, - "completedAt": { - "type": "string", - "description": "When the recalculation reached a terminal state (Completed, Failed, Aborted).", - "format": "date-time", - "nullable": true - }, - "createdAt": { - "type": "string", - "description": "When the recalculation was created.", - "format": "date-time" - } - } - }, - "GetAudienceUserStateMetricsResult": { - "required": [ - "usersPerState" - ], - "type": "object", - "properties": { - "usersPerState": { - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - } - } - }, - "GetLatestAudienceInactivitySyncEndpoint_Output": { - "required": [ - "id", - "audienceId", - "state", - "phase", - "cutoff", - "processedCount", - "changedCount", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the inactivity sync." - }, - "audienceId": { - "type": "string", - "description": "The audience this inactivity sync belongs to." - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceInactivitySyncState" - } - ], - "description": "The current state of the inactivity sync." - }, - "phase": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceInactivitySyncPhase" - } - ], - "description": "The current phase within the inactivity sync lifecycle." - }, - "cutoff": { - "type": "string", - "description": "The cutoff captured at run creation time. Users with last_seen_at older than this are marked inactive.", - "format": "date-time" - }, - "lastProcessedUserId": { - "type": "string", - "description": "The id of the last user that was processed (progress cursor).", - "nullable": true - }, - "processedCount": { - "type": "integer", - "description": "The number of users processed so far.", - "format": "int64" - }, - "changedCount": { - "type": "integer", - "description": "The number of users whose state was changed by the sync.", - "format": "int64" - }, - "errorMessage": { - "type": "string", - "description": "Error message populated when the sync transitioned to Failed.", - "nullable": true - }, - "startedAt": { - "type": "string", - "description": "When the sync began processing (null while still Pending).", - "format": "date-time", - "nullable": true - }, - "lastHeartbeatAt": { - "type": "string", - "description": "Timestamp of the last heartbeat received from the worker.", - "format": "date-time", - "nullable": true - }, - "completedAt": { - "type": "string", - "description": "When the sync reached a terminal state (Completed, Failed, Aborted).", - "format": "date-time", - "nullable": true - }, - "createdAt": { - "type": "string", - "description": "When the sync was created.", - "format": "date-time" - } - } - }, - "GetLatestAudienceStateRecalculationEndpoint_Output": { - "required": [ - "id", - "audienceId", - "state", - "phase", - "processedCount", - "changedCount", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the recalculation." - }, - "audienceId": { - "type": "string", - "description": "The audience this recalculation belongs to." - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceStateRecalculationState" - } - ], - "description": "The current state of the recalculation." - }, - "phase": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceStateRecalculationPhase" - } - ], - "description": "The current phase within the recalculation lifecycle." - }, - "lastProcessedUserId": { - "type": "string", - "description": "The id of the last user that was processed (progress cursor).", - "nullable": true - }, - "processedCount": { - "type": "integer", - "description": "The number of users processed so far.", - "format": "int64" - }, - "changedCount": { - "type": "integer", - "description": "The number of users whose state was changed by the recalculation.", - "format": "int64" - }, - "errorMessage": { - "type": "string", - "description": "Error message populated when the recalculation transitioned to Failed.", - "nullable": true - }, - "startedAt": { - "type": "string", - "description": "When the recalculation began processing (null while still Pending).", - "format": "date-time", - "nullable": true - }, - "lastHeartbeatAt": { - "type": "string", - "description": "Timestamp of the last heartbeat received from the worker.", - "format": "date-time", - "nullable": true - }, - "completedAt": { - "type": "string", - "description": "When the recalculation reached a terminal state (Completed, Failed, Aborted).", - "format": "date-time", - "nullable": true - }, - "createdAt": { - "type": "string", - "description": "When the recalculation was created.", - "format": "date-time" - } - } - }, - "IAsset": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAssetFileAsset" - }, - { - "$ref": "#/components/schemas/IAssetMultiAsset" - }, - { - "$ref": "#/components/schemas/IAssetNullAsset" - }, - { - "$ref": "#/components/schemas/IAssetTextAsset" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FileAsset": "#/components/schemas/IAssetFileAsset", - "MultiAsset": "#/components/schemas/IAssetMultiAsset", - "NullAsset": "#/components/schemas/IAssetNullAsset", - "TextAsset": "#/components/schemas/IAssetTextAsset" - } - } - }, - "IAssetFileAsset": { - "required": [ - "fileName", - "metadata", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FileAsset" - ], - "type": "string" - }, - "fileName": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataModelCollection" - }, - "identifier": { - "type": "string" - } - } - }, - "IAssetInput": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAssetInputExistingAssetInput" - }, - { - "$ref": "#/components/schemas/IAssetInputMultiAssetInput" - }, - { - "$ref": "#/components/schemas/IAssetInputTextAssetInput" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ExistingAssetInput": "#/components/schemas/IAssetInputExistingAssetInput", - "MultiAssetInput": "#/components/schemas/IAssetInputMultiAssetInput", - "TextAssetInput": "#/components/schemas/IAssetInputTextAssetInput" - } - } - }, - "IAssetInputExistingAssetInput": { - "required": [ - "name", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ExistingAssetInput" - ], - "type": "string" - }, - "name": { - "type": "string" - }, - "metadata": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/MetadataInputCollection" - } - ], - "nullable": true - }, - "identifier": { - "type": "string", - "nullable": true - } - } - }, - "IAssetInputMultiAssetInput": { - "required": [ - "assets", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "MultiAssetInput" - ], - "type": "string" - }, - "assets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IAssetInput" - } - }, - "metadata": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/MetadataInputCollection" - } - ], - "nullable": true - }, - "identifier": { - "type": "string", - "nullable": true - } - } - }, - "IAssetInputTextAssetInput": { - "required": [ - "text", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TextAssetInput" - ], - "type": "string" - }, - "text": { - "type": "string" - }, - "metadata": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/MetadataInputCollection" - } - ], - "nullable": true - }, - "identifier": { - "type": "string", - "nullable": true - } - } - }, - "IAssetMultiAsset": { - "required": [ - "assets", - "metadata", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "MultiAsset" - ], - "type": "string" - }, - "assets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IAsset" - } - }, - "metadata": { - "$ref": "#/components/schemas/MetadataModelCollection" - }, - "identifier": { - "type": "string" - } - } - }, - "IAssetNullAsset": { - "required": [ - "metadata", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NullAsset" - ], - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataModelCollection" - }, - "identifier": { - "type": "string" - } - } - }, - "IAssetTextAsset": { - "required": [ - "text", - "metadata", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TextAsset" - ], - "type": "string" - }, - "text": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataModelCollection" - }, - "identifier": { - "type": "string" - } - } - }, - "IAudienceFilter": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAudienceFilterAndAudienceFilter" - }, - { - "$ref": "#/components/schemas/IAudienceFilterCountryAudienceFilter" - }, - { - "$ref": "#/components/schemas/IAudienceFilterDemographicAudienceFilter" - }, - { - "$ref": "#/components/schemas/IAudienceFilterDeviceAudienceFilter" - }, - { - "$ref": "#/components/schemas/IAudienceFilterLanguageAudienceFilter" - }, - { - "$ref": "#/components/schemas/IAudienceFilterNotAudienceFilter" - }, - { - "$ref": "#/components/schemas/IAudienceFilterOrAudienceFilter" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "AndFilter": "#/components/schemas/IAudienceFilterAndAudienceFilter", - "CountryFilter": "#/components/schemas/IAudienceFilterCountryAudienceFilter", - "DemographicFilter": "#/components/schemas/IAudienceFilterDemographicAudienceFilter", - "DeviceFilter": "#/components/schemas/IAudienceFilterDeviceAudienceFilter", - "LanguageFilter": "#/components/schemas/IAudienceFilterLanguageAudienceFilter", - "NotFilter": "#/components/schemas/IAudienceFilterNotAudienceFilter", - "OrFilter": "#/components/schemas/IAudienceFilterOrAudienceFilter" - } - } - }, - "IAudienceFilterAndAudienceFilter": { - "required": [ - "filters", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "AndFilter" - ], - "type": "string" - }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IAudienceFilter" - } - } - } - }, - "IAudienceFilterCountryAudienceFilter": { - "required": [ - "countries", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CountryFilter" - ], - "type": "string" - }, - "countries": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IAudienceFilterDemographicAudienceFilter": { - "required": [ - "identifier", - "values", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "DemographicFilter" - ], - "type": "string" - }, - "identifier": { - "type": "string" - }, - "values": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IAudienceFilterDeviceAudienceFilter": { - "required": [ - "deviceTypes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "DeviceFilter" - ], - "type": "string" - }, - "deviceTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceType" - } - } - } - }, - "IAudienceFilterLanguageAudienceFilter": { - "required": [ - "languages", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LanguageFilter" - ], - "type": "string" - }, - "languages": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IAudienceFilterNotAudienceFilter": { - "required": [ - "filter", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NotFilter" - ], - "type": "string" - }, - "filter": { - "$ref": "#/components/schemas/IAudienceFilter" - } - } - }, - "IAudienceFilterOrAudienceFilter": { - "required": [ - "filters", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "OrFilter" - ], - "type": "string" - }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IAudienceFilter" - } - } - } - }, - "IExamplePayload": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IExamplePayloadClassifyExamplePayload" - }, - { - "$ref": "#/components/schemas/IExamplePayloadCompareExamplePayload" - }, - { - "$ref": "#/components/schemas/IExamplePayloadLineExamplePayload" - }, - { - "$ref": "#/components/schemas/IExamplePayloadLocateExamplePayload" - }, - { - "$ref": "#/components/schemas/IExamplePayloadScrubExamplePayload" - }, - { - "$ref": "#/components/schemas/IExamplePayloadTranscriptionExamplePayload" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassifyExamplePayload": "#/components/schemas/IExamplePayloadClassifyExamplePayload", - "CompareExamplePayload": "#/components/schemas/IExamplePayloadCompareExamplePayload", - "LineExamplePayload": "#/components/schemas/IExamplePayloadLineExamplePayload", - "LocateExamplePayload": "#/components/schemas/IExamplePayloadLocateExamplePayload", - "ScrubExamplePayload": "#/components/schemas/IExamplePayloadScrubExamplePayload", - "TranscriptionExamplePayload": "#/components/schemas/IExamplePayloadTranscriptionExamplePayload" - } - } - }, - "IExamplePayloadClassifyExamplePayload": { - "required": [ - "categories", - "title", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyExamplePayload" - ], - "type": "string" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleCategory" - } - }, - "title": { - "type": "string" - } - } - }, - "IExamplePayloadCompareExamplePayload": { - "required": [ - "criteria", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CompareExamplePayload" - ], - "type": "string" - }, - "criteria": { - "type": "string" - } - } - }, - "IExamplePayloadLineExamplePayload": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LineExamplePayload" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IExamplePayloadLocateExamplePayload": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocateExamplePayload" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IExamplePayloadScrubExamplePayload": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScrubExamplePayload" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IExamplePayloadTranscriptionExamplePayload": { - "required": [ - "title", - "transcription", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TranscriptionExamplePayload" - ], - "type": "string" - }, - "title": { - "type": "string" - }, - "transcription": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleTranscriptionWord" - } - } - } - }, - "IExampleTruth": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IExampleTruthClassifyExampleTruth" - }, - { - "$ref": "#/components/schemas/IExampleTruthCompareExampleTruth" - }, - { - "$ref": "#/components/schemas/IExampleTruthLineExampleTruth" - }, - { - "$ref": "#/components/schemas/IExampleTruthLocateExampleTruth" - }, - { - "$ref": "#/components/schemas/IExampleTruthScrubExampleTruth" - }, - { - "$ref": "#/components/schemas/IExampleTruthTranscriptionExampleTruth" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassifyExampleTruth": "#/components/schemas/IExampleTruthClassifyExampleTruth", - "CompareExampleTruth": "#/components/schemas/IExampleTruthCompareExampleTruth", - "LineExampleTruth": "#/components/schemas/IExampleTruthLineExampleTruth", - "LocateExampleTruth": "#/components/schemas/IExampleTruthLocateExampleTruth", - "ScrubExampleTruth": "#/components/schemas/IExampleTruthScrubExampleTruth", - "TranscriptionExampleTruth": "#/components/schemas/IExampleTruthTranscriptionExampleTruth" - } - } - }, - "IExampleTruthClassifyExampleTruth": { - "required": [ - "correctCategories", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyExampleTruth" - ], - "type": "string" - }, - "correctCategories": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IExampleTruthCompareExampleTruth": { - "required": [ - "winnerId", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CompareExampleTruth" - ], - "type": "string" - }, - "winnerId": { - "type": "string" - } - } - }, - "IExampleTruthLineExampleTruth": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LineExampleTruth" - ], - "type": "string" - }, - "boundingBoxes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleBoxShape" - }, - "nullable": true - }, - "requiredPrecision": { - "type": "number", - "format": "double", - "nullable": true - }, - "requiredCompleteness": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "IExampleTruthLocateExampleTruth": { - "required": [ - "boundingBoxes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocateExampleTruth" - ], - "type": "string" - }, - "boundingBoxes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleBoxShape" - } - }, - "requiredPrecision": { - "type": "number", - "format": "double", - "nullable": true - }, - "requiredCompleteness": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "IExampleTruthScrubExampleTruth": { - "required": [ - "validRanges", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScrubExampleTruth" - ], - "type": "string" - }, - "validRanges": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleScrubRange" - } - } - } - }, - "IExampleTruthTranscriptionExampleTruth": { - "required": [ - "correctWords", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TranscriptionExampleTruth" - ], - "type": "string" - }, - "correctWords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleTranscriptionWord" - } - }, - "strictGrading": { - "type": "boolean", - "nullable": true - }, - "requiredPrecision": { - "type": "number", - "format": "double", - "nullable": true - }, - "requiredCompleteness": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "IGraduationRule": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IGraduationRuleAcceptedFreeTextRule" - }, - { - "$ref": "#/components/schemas/IGraduationRuleScoreThresholdRule" - }, - { - "$ref": "#/components/schemas/IGraduationRuleTaskAccuracyRule" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "AcceptedFreeText": "#/components/schemas/IGraduationRuleAcceptedFreeTextRule", - "ScoreThreshold": "#/components/schemas/IGraduationRuleScoreThresholdRule", - "TaskAccuracy": "#/components/schemas/IGraduationRuleTaskAccuracyRule" - } - } - }, - "IGraduationRuleAcceptedFreeTextRule": { - "required": [ - "minAcceptedResponses", - "minAcceptedRatio", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "AcceptedFreeText" - ], - "type": "string" - }, - "minAcceptedResponses": { - "type": "integer", - "format": "uint32" - }, - "minAcceptedRatio": { - "type": "number", - "format": "double" - }, - "demotionRatio": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "IGraduationRuleScoreThresholdRule": { - "required": [ - "graduationScore", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScoreThreshold" - ], - "type": "string" - }, - "graduationScore": { - "type": "number", - "format": "double" - }, - "demotionScore": { - "type": "number", - "format": "double", - "nullable": true - }, - "minResponsesToGraduate": { - "type": "integer", - "format": "uint32", - "nullable": true - } - } + } + }, + "components": { + "schemas": { + "BatchUploadStatus": { + "enum": [ + "Processing", + "Completed", + "Aborted" + ] }, - "IGraduationRuleTaskAccuracyRule": { - "required": [ - "targetAccuracy", - "minTasks", - "_t" - ], + "BatchUploadUrlStatus": { + "enum": [ + "Pending", + "Completed", + "Failed" + ] + }, + "CompressionOverride": { + "type": "object", "properties": { - "_t": { - "enum": [ - "TaskAccuracy" - ], - "type": "string" - }, - "targetAccuracy": { - "type": "number", - "format": "double" + "enabled": { + "type": "boolean", + "nullable": true }, - "minTasks": { + "quality": { "type": "integer", - "format": "int32" + "format": "int32", + "nullable": true }, - "maxTasks": { + "maxDimension": { "type": "integer", "format": "int32", "nullable": true } } }, - "IMetadata": { + "CreateBatchUploadEndpoint_Input": { "required": [ - "_t" + "urls" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IMetadataClassificationMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataCountMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataFileTypeMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataImageDimensionMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataLocationMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataOriginalFilenameMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataSourceUrlMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataStreamsMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataTextMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataVideoDurationMetadata" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassificationMetadata": "#/components/schemas/IMetadataClassificationMetadata", - "CountMetadata": "#/components/schemas/IMetadataCountMetadata", - "FileTypeMetadata": "#/components/schemas/IMetadataFileTypeMetadata", - "ImageDimensionMetadata": "#/components/schemas/IMetadataImageDimensionMetadata", - "LocationMetadata": "#/components/schemas/IMetadataLocationMetadata", - "OriginalFilenameMetadata": "#/components/schemas/IMetadataOriginalFilenameMetadata", - "SourceUrlMetadataModel": "#/components/schemas/IMetadataSourceUrlMetadata", - "StreamsMetadata": "#/components/schemas/IMetadataStreamsMetadata", - "TextMetadata": "#/components/schemas/IMetadataTextMetadata", - "VideoDurationMetadata": "#/components/schemas/IMetadataVideoDurationMetadata" - } - } - }, - "IMetadataClassificationMetadata": { - "required": [ - "classification", - "_t" - ], "properties": { - "_t": { - "enum": [ - "ClassificationMetadata" + "urls": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string", + "format": "uri" + } + } ], - "type": "string" + "description": "The URLs to download and process." }, - "classification": { - "type": "string" - } - } - }, - "IMetadataCountMetadata": { - "required": [ - "count", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CountMetadata" - ], - "type": "string" + "correlationId": { + "type": "string", + "description": "Optional client-supplied identifier to group related batch uploads.", + "nullable": true }, - "count": { - "type": "integer", - "format": "int32" + "compression": { + "allOf": [ + { + "$ref": "#/components/schemas/CompressionOverride" + } + ], + "description": "Optional per-call override for image compression applied to every URL in the batch.\n Null means use the configured defaults." } } }, - "IMetadataFileTypeMetadata": { + "CreateBatchUploadEndpoint_Output": { "required": [ - "fileType", - "_t" + "batchUploadId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FileTypeMetadata" - ], - "type": "string" - }, - "fileType": { - "$ref": "#/components/schemas/FileType" + "batchUploadId": { + "type": "string", + "description": "The identifier of the created batch upload." } } }, - "IMetadataImageDimensionMetadata": { + "GetBatchUploadResultEndpoint_Output": { "required": [ - "_t" + "batchUploadId", + "status", + "totalCount", + "completedCount", + "failedCount", + "items" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ImageDimensionMetadata" + "batchUploadId": { + "type": "string", + "description": "The identifier of the batch upload." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/BatchUploadStatus" + } ], - "type": "string" + "description": "The current status of the batch upload." }, - "height": { + "totalCount": { "type": "integer", + "description": "The total number of URLs in the batch.", "format": "int32" }, - "width": { + "completedCount": { "type": "integer", + "description": "The number of URLs that have been successfully processed.", "format": "int32" - } - } - }, - "IMetadataInput": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IMetadataInputTextMetadataInput" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "TextMetadataInput": "#/components/schemas/IMetadataInputTextMetadataInput" - } - } - }, - "IMetadataInputTextMetadataInput": { - "required": [ - "text", - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TextMetadataInput" - ], - "type": "string" - }, - "text": { - "type": "string", - "nullable": true - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IMetadataLocationMetadata": { - "required": [ - "x", - "y", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocationMetadata" - ], - "type": "string" }, - "x": { - "type": "number", - "format": "float" + "failedCount": { + "type": "integer", + "description": "The number of URLs that failed to process.", + "format": "int32" }, - "y": { - "type": "number", - "format": "float" - } - } - }, - "IMetadataOriginalFilenameMetadata": { - "required": [ - "originalFilename", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "OriginalFilenameMetadata" + "items": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBatchUploadResultEndpoint_UrlOutput" + } + } ], - "type": "string" - }, - "originalFilename": { - "type": "string" + "description": "The individual results for each URL in the batch." } } }, - "IMetadataSourceUrlMetadata": { + "GetBatchUploadResultEndpoint_UrlOutput": { "required": [ "url", - "_t" + "status" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "SourceUrlMetadataModel" - ], - "type": "string" - }, "url": { "type": "string" - } - } - }, - "IMetadataStreamsMetadata": { - "required": [ - "hasVideo", - "hasAudio", - "hasSubtitles", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "StreamsMetadata" - ], - "type": "string" }, - "hasVideo": { - "type": "boolean" + "fileName": { + "type": "string", + "nullable": true }, - "hasAudio": { - "type": "boolean" + "warnings": { + "type": "array", + "items": { + "type": "string" + } }, - "hasSubtitles": { - "type": "boolean" - } - } - }, - "IMetadataTextMetadata": { - "required": [ - "text", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TextMetadata" - ], - "type": "string" + "status": { + "$ref": "#/components/schemas/BatchUploadUrlStatus" }, - "text": { + "errorMessage": { "type": "string", "nullable": true - } - } - }, - "IMetadataVideoDurationMetadata": { - "required": [ - "duration", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "VideoDurationMetadata" - ], - "type": "string" }, - "duration": { + "stage": { "type": "string", - "format": "date-time" + "nullable": true + }, + "upstreamHttpStatus": { + "type": "integer", + "format": "int32", + "nullable": true } } }, - "MetadataInputCollection": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IMetadataInput" - } - }, - "MetadataModelCollection": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IMetadata" - } - }, - "MetadataVisibilities": { - "type": "array", - "items": { - "enum": [ - "None", - "Users", - "Customers", - "Admins", - "Dashboard", - "All" - ], - "type": "string" - } - }, - "QueryAudienceJobsEndpoint_Output": { + "GetBatchUploadStatusEndpoint_Output": { "required": [ - "jobId", - "name", - "definitionId", - "audienceId", - "revisionNumber", - "pipelineId", - "state", - "createdAt" + "status", + "totalCount", + "completedCount", + "failedCount", + "completedBatches" ], "type": "object", "properties": { - "jobId": { - "type": "string", - "description": "The unique identifier of the job." - }, - "name": { - "type": "string", - "description": "The name of the job." - }, - "definitionId": { - "type": "string", - "description": "The identifier of the job definition." - }, - "audienceId": { - "type": "string", - "description": "The identifier of the audience the job belongs to." - }, - "revisionNumber": { - "type": "integer", - "description": "The revision number of the job definition.", - "format": "int32" - }, - "pipelineId": { - "type": "string", - "description": "The identifier of the pipeline executing the job." - }, "status": { "allOf": [ { - "$ref": "#/components/schemas/AudienceJobState" - } - ], - "description": "The current status of the job.", - "deprecated": true - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceJobState" + "$ref": "#/components/schemas/BatchUploadStatus" } ], - "description": "The current status of the job." - }, - "createdAt": { - "type": "string", - "description": "The timestamp when the job was created.", - "format": "date-time" - } - } - }, - "QueryAudienceJobsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" + "description": "The aggregated status across all queried batch uploads." }, - "page": { + "totalCount": { "type": "integer", + "description": "The total number of URLs across all queried batches.", "format": "int32" }, - "pageSize": { + "completedCount": { "type": "integer", + "description": "The number of URLs that have been successfully processed.", "format": "int32" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryAudienceJobsEndpoint_Output" - } - }, - "totalPages": { + "failedCount": { "type": "integer", + "description": "The number of URLs that failed to process.", "format": "int32" + }, + "completedBatches": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The identifiers of batch uploads that have fully completed." } } }, - "QueryAudiencesEndpoint_Output": { + "IFormFile": { + "type": "string", + "format": "binary" + }, + "UploadFileEndpoint_Output": { "required": [ - "id", - "name", - "status", - "qualifiedUserCount", - "filters", - "createdAt", - "ownerMail", - "organizationId", - "isPublic", - "isDistilling", - "graduationRule" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the audience." - }, - "name": { - "type": "string", - "description": "The name of the audience." - }, - "description": { + "fileName", + "warnings", + "wasCompressed" + ], + "type": "object", + "properties": { + "fileName": { "type": "string", - "description": "The markdown-supported description of the audience.", - "nullable": true - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceStatus" - } - ], - "description": "The current status of the audience." - }, - "qualifiedUserCount": { - "type": "integer", - "description": "The number of users that have qualified for this audience.", - "format": "int64" + "description": "The generated file name used internally to reference the uploaded asset.\n This is not the original file name and should be used for all subsequent operations on this asset." }, - "filters": { + "warnings": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/IAudienceFilter" + "type": "string" } } ], - "description": "The filters applied to this audience." - }, - "logo": { - "type": "string", - "description": "The URL of the audience logo, if any.", - "nullable": true + "description": "Any warnings that might have occurred during the upload." }, - "createdAt": { - "type": "string", - "description": "The timestamp when the audience was created.", - "format": "date-time" + "wasCompressed": { + "type": "boolean", + "description": "Whether the uploaded file was compressed during processing." }, - "ownerMail": { - "type": "string", - "description": "The email of the audience owner." + "originalSizeBytes": { + "type": "integer", + "description": "The original size of the uploaded file in bytes, if available. This may be null if the size could not be determined.", + "format": "int64", + "nullable": true }, - "organizationId": { + "finalSizeBytes": { + "type": "integer", + "description": "The final size of the stored file in bytes after processing (e.g., compression), if available.\n This may be null if the size could not be determined. If compression was applied, this size may be smaller than the original size.", + "format": "int64", + "nullable": true + } + } + }, + "UploadFileFromUrlEndpoint_Output": { + "required": [ + "fileName", + "warnings", + "wasCompressed" + ], + "type": "object", + "properties": { + "fileName": { "type": "string", - "description": "The id of the organization that owns the entity." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the audience is publicly visible." - }, - "isDistilling": { - "type": "boolean", - "description": "Whether the audience is currently distilling users." + "description": "The generated file name used internally to reference the uploaded asset.\n This is not the original file name and should be used for all subsequent operations on this asset." }, - "graduationRule": { + "warnings": { "allOf": [ { - "$ref": "#/components/schemas/IGraduationRule" + "type": "array", + "items": { + "type": "string" + } } ], - "description": "The rule this audience uses to graduate users — a score-threshold rule or a\n task-accuracy rule." - }, - "randomAdmissionProbability": { - "type": "number", - "description": "The probability of admitting a random user to the audience.", - "format": "double", - "nullable": true + "description": "Any warnings that might have occurred during the upload." }, - "health": { - "type": "number", - "description": "The health score of the audience.", - "format": "double", - "nullable": true + "wasCompressed": { + "type": "boolean", + "description": "Whether the uploaded file was compressed during processing." }, - "graduated": { + "originalSizeBytes": { "type": "integer", - "description": "The number of graduated users.", - "format": "int64" + "description": "The original size of the uploaded file in bytes, if available. This may be null if the size could not be determined.", + "format": "int64", + "nullable": true }, - "dropped": { + "finalSizeBytes": { "type": "integer", - "description": "The number of dropped users.", - "format": "int64" + "description": "The final size of the stored file in bytes after processing (e.g., compression), if available.\n This may be smaller than the original size if compression was applied.", + "format": "int64", + "nullable": true } } }, - "QueryAudiencesEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], + "ValidationProblemDetails": { "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" + "type": { + "type": "string", + "nullable": true }, - "page": { - "type": "integer", - "format": "int32" + "title": { + "type": "string", + "nullable": true }, - "pageSize": { + "status": { "type": "integer", - "format": "int32" + "format": "int32", + "nullable": true }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryAudiencesEndpoint_Output" - } + "detail": { + "type": "string", + "nullable": true }, - "totalPages": { - "type": "integer", - "format": "int32" + "instance": { + "type": "string", + "nullable": true + }, + "errors": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } } } }, - "QueryExamplesForAudienceEndpoint_Output": { + "AddExampleToAudienceEndpoint_Input": { "required": [ - "id", "asset", "payload", - "correctCount", - "incorrectCount" + "randomCorrectProbability" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the example." - }, - "rapidId": { - "type": "string", - "description": "The ID of the rapid associated with this example.", - "nullable": true - }, "asset": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/IAssetInput" } ], - "description": "The asset associated with this example." + "description": "The asset to use for the example." }, "payload": { "allOf": [ @@ -45173,17 +41312,7 @@ "$ref": "#/components/schemas/IExamplePayload" } ], - "description": "The payload of the example." - }, - "correctCount": { - "type": "integer", - "description": "The number of correct responses.", - "format": "int32" - }, - "incorrectCount": { - "type": "integer", - "description": "The number of incorrect responses.", - "format": "int32" + "description": "The payload to use for the example." }, "truth": { "allOf": [ @@ -45191,137 +41320,167 @@ "$ref": "#/components/schemas/IExampleTruth" } ], - "description": "The truth value of the example." + "description": "The ground truth for the example." + }, + "randomCorrectProbability": { + "type": "number", + "description": "The probability for an answer to be correct when randomly guessing.", + "format": "double" + }, + "explanation": { + "type": "string", + "description": "An explanation for the users if they answer the example incorrectly.", + "nullable": true }, "context": { "type": "string", - "description": "The context text for the example.", + "description": "An optional textual context that provides additional information to the user.", "nullable": true }, "contextAsset": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/IAssetInput" } ], - "description": "The context asset for the example." + "description": "An optional asset that provides additional context to the user." }, - "explanation": { - "type": "string", - "description": "The explanation for the example.", + "sortIndex": { + "type": "integer", + "description": "The sort index that controls the serving order of this example within the audience.\n When null, the next sort index is automatically calculated.", + "format": "int32", "nullable": true }, - "randomCorrectProbability": { - "type": "number", - "description": "The probability of a random correct answer.", - "format": "double" + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "The feature flags to enable for the example." }, "isCommonSense": { "type": "boolean", - "description": "Whether this example is common sense.", + "description": "Whether this example should be treated as commonsense validation.\n When true, incorrect answers are not accepted and the example affects global score.\n When null, AI auto-detection will determine if the example is common sense.", "nullable": true }, - "sortIndex": { - "type": "integer", - "description": "The sort index that controls serving order.", - "format": "int32" - }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/ExampleVisibility" } ], - "description": "The visibility of this example. Public examples are visible to all customers." + "description": "Controls who can see this example. Public examples are visible to all customers.\n Private examples are only visible to the customer who created them and admins.\n Defaults to Private." } - } + }, + "description": "Input model for adding an example to an audience." }, - "QueryExamplesForAudienceEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], + "AddExampleToAudienceEndpoint_Output": { "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryExamplesForAudienceEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" + "recalculationId": { + "type": "string", + "description": "The id of the audience state recalculation dispatched as a result of adding this example.\n Null when the example addition cannot transition any user's state (e.g. the audience\n already has more examples than MaxDistillingResponses + 1).", + "nullable": true } } }, - "RecreateExternalAudiencesEndpoint_Input": { - "required": [ - "recreateAll" - ], - "type": "object", - "properties": { - "recreateAll": { - "type": "boolean", - "description": "Whether to recreate all 3 external audiences or only the missing ones." - } - } + "AudienceInactivitySyncPhase": { + "enum": [ + "MarkingInactiveUsers", + "Finalizing", + "Done" + ] }, - "RetrievalMode": { + "AudienceInactivitySyncState": { "enum": [ - "Random", - "Shuffled", - "Sequential" + "Pending", + "Processing", + "Completed", + "Failed", + "Aborted" ] }, - "StartAudienceInactivitySyncEndpoint_Output": { + "AudienceJobState": { + "enum": [ + "Submitted", + "Running", + "Completed", + "Failed", + "ManualApproval", + "Queued", + "Paused", + "StaleResults", + "SpendLimited" + ] + }, + "AudienceStateRecalculationPhase": { + "enum": [ + "RecalculatingUsers", + "Finalizing", + "Done" + ] + }, + "AudienceStateRecalculationState": { + "enum": [ + "Pending", + "Processing", + "Completed", + "Failed", + "Aborted" + ] + }, + "AudienceStatus": { + "enum": [ + "Created", + "Pending", + "Recruiting", + "Ready" + ] + }, + "BoostLevel": { + "enum": [ + "None", + "Stable", + "Distilling", + "Global" + ] + }, + "ChangeAudienceOwnerEndpoint_Input": { "required": [ - "syncId" + "ownerId", + "ownerMail" ], "type": "object", "properties": { - "syncId": { + "ownerId": { "type": "string", - "description": "The id of the inactivity sync that was started or reused." + "description": "The unique identifier of the new owner.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The email address of the new owner." } } }, - "StartAudienceStateRecalculationEndpoint_Output": { + "CreateAudienceEndpoint_Input": { "required": [ - "recalculationId" + "name" ], - "type": "object", - "properties": { - "recalculationId": { - "type": "string", - "description": "The id of the recalculation that was started or reused." - } - } - }, - "UpdateAudienceEndpoint_Input": { "type": "object", "properties": { "name": { "type": "string", - "description": "The new name to give to this audience." + "description": "The name to give the newly created audience." }, "description": { "type": "string", - "description": "The new description for the audience. Supports markdown. Set to null to remove.", + "description": "An optional markdown-supported description of the audience's purpose.", "nullable": true }, "filters": { @@ -45330,5573 +41489,5613 @@ "type": "array", "items": { "$ref": "#/components/schemas/IAudienceFilter" - } + }, + "nullable": true } ], - "description": "The new filters to apply to any orders created for this audience.\n A filter can be used to restrict the audience to a specific subset of users." + "description": "The filters to apply to any orders created for this audience.\n A filter can be used to restrict the audience to a specific subset of users." }, - "logo": { - "type": "object", - "oneOf": [ + "graduationRule": { + "allOf": [ { - "$ref": "#/components/schemas/ExistingAssetInput" + "$ref": "#/components/schemas/IGraduationRule" } ], - "description": "The new logo image for the audience. Must be an existing image asset.\n Set to null to remove the logo.", - "nullable": true - }, - "minGraduatedForDistillingBoost": { - "type": "integer", - "description": "Minimum graduated users before disabling distilling boost.\n When graduated count is below this, external distilling audience ID is added to campaign boosting.", - "format": "int32", - "nullable": true + "description": "How users graduate into this audience — either a score-threshold rule or a\n task-accuracy rule (\"solve N tasks at X accuracy\"). When omitted, new audiences\n default to a task-accuracy rule (0.75 accuracy over 10 tasks)." }, - "minDistillingForGlobalBoost": { + "minimumSizeForActivation": { "type": "integer", - "description": "Minimum distilling users before disabling global boost.\n When distilling count is below this, GlobalBoostLevel is set above zero.", - "format": "int32", + "description": "The minimum number of users required for an audience to be activated.", + "format": "int64", "nullable": true }, - "graduationRule": { + "logo": { "allOf": [ { - "$ref": "#/components/schemas/IGraduationRule" + "$ref": "#/components/schemas/ExistingAssetInput" } ], - "description": "Replaces how users graduate into this audience — either a score-threshold rule or a\n task-accuracy rule." + "description": "An optional logo image for the audience. Must be an existing image asset." }, "maxDistillingResponses": { "type": "integer", - "description": "Maximum responses before user exits the distilling campaign.\n Set to null to disable this exit condition.", + "description": "Maximum responses before user exits the distilling campaign.\n Defaults to 10. Set to null to disable this exit condition.", "format": "uint32", "nullable": true }, "dropMinResponses": { "type": "integer", - "description": "Minimum responses before the drop score check applies.\n Users need at least this many responses before they can be kicked out for low score.\n Set to null to apply drop score check from the first response.", + "description": "Minimum responses before the drop score check applies.\n Users need at least this many responses before they can be kicked out for low score.\n Defaults to 3. Set to null to apply drop score check from the first response.", "format": "uint32", "nullable": true }, "dropScore": { "type": "number", - "description": "Score floor - users below this score exit the distilling campaign\n (only after completing DropMinResponses).\n Set to null to disable this exit condition.", + "description": "Score floor - users below this score exit the distilling campaign\n (only after completing DropMinResponses).\n Defaults to 0.2. Set to null to disable this exit condition.", "format": "double", "nullable": true }, + "isDistillingCampaignSticky": { + "type": "boolean", + "description": "Whether the distilling campaign should be sticky (users stay until filters don't match).\n Defaults to true (Temporary sticky)." + }, "maxDistillingSessions": { "type": "integer", - "description": "Maximum sessions (rapid retrievals) before user exits the distilling campaign.\n Set to a value to enable session-based exit condition.", + "description": "Maximum sessions (rapid retrievals) before user exits the distilling campaign.\n Defaults to null (disabled). Set to a value to enable session-based exit condition.", "format": "uint32", "nullable": true }, "inactivityDropDays": { "type": "integer", - "description": "Number of days of inactivity before a distilling user is dropped.\n Set to null to disable this exit condition.", + "description": "Number of days of inactivity before a distilling user is dropped.\n Defaults to null (disabled).", "format": "uint32", "nullable": true }, "minSubmissionRate": { "type": "number", - "description": "Minimum submission rate (responses / sessions) before a user is dropped.\n Set to null to disable this exit condition.", + "description": "Minimum submission rate (responses / sessions) before a user is dropped.\n Defaults to null (disabled).", "format": "double", "nullable": true }, "minSessionsForSubmissionRate": { "type": "integer", - "description": "Minimum number of sessions before the submission rate check applies.\n Set to null to apply from the first session.", + "description": "Minimum number of sessions before the submission rate check applies.\n Defaults to null (applies from first session).", "format": "uint32", "nullable": true }, "minSubmissionRateGraduated": { "type": "number", - "description": "Minimum submission rate for graduated users. If null, MinSubmissionRate applies to graduated users.\n Set a lower value to be more lenient with graduated users.", - "format": "double", - "nullable": true - }, - "distillingRetrievalMode": { - "allOf": [ - { - "$ref": "#/components/schemas/RetrievalMode" - } - ], - "description": "The retrieval mode used by the distilling campaign to select rapids for users." - } - } - }, - "UpdateAudienceEndpoint_Output": { - "type": "object", - "properties": { - "recalculationId": { - "type": "string", - "description": "The id of the audience state recalculation that was dispatched as a result of this update.\n Only populated when state-affecting parameters (e.g. graduation score, drop score) changed;\n null when the update only touched descriptive fields or boost configuration.", - "nullable": true - }, - "inactivitySyncId": { - "type": "string", - "description": "The id of the audience inactivity sync that was dispatched as a result of this update.\n Only populated when InactivityDropDays was changed to a non-null value; null otherwise.", - "nullable": true - } - } - }, - "UpdateAudienceExampleEndpoint_Input": { - "type": "object", - "properties": { - "truth": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IExampleTruth" - } - ], - "description": "The truth for the example.", - "nullable": true - }, - "instructionText": { - "type": "string", - "description": "The instruction shown to the user — the criteria for a compare example, the target\n for a locate, line or scrub example, or the title for a classify or transcription\n example. The example's answer options are left unchanged." - }, - "explanation": { - "type": "string", - "description": "The optional explanation that will be shown to the user when answering wrong.", - "nullable": true - }, - "context": { - "type": "string", - "description": "An optional text context that will be shown to the user.", - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "An optional asset that will be used as context to show to the user.", - "nullable": true - }, - "randomCorrectProbability": { - "type": "number", - "description": "The probability that if the user answers at random that they'll be correct.", - "format": "double", - "nullable": true - }, - "isCommonSense": { - "type": "boolean", - "description": "Whether this example should be treated as commonsense validation.", - "nullable": true - }, - "sortIndex": { - "type": "integer", - "description": "The sort index that controls the serving order of this example.", - "format": "int32" + "description": "Minimum submission rate for graduated users. If null, MinSubmissionRate applies to graduated users.\n Set a lower value to be more lenient with graduated users.", + "format": "double", + "nullable": true }, - "visibility": { + "distillingRetrievalMode": { "allOf": [ { - "$ref": "#/components/schemas/ExampleVisibility" + "$ref": "#/components/schemas/RetrievalMode" } ], - "description": "Controls who can see this example. Public examples are visible to all customers.\n Private examples are only visible to the customer who created them and admins." - } - }, - "description": "Input model for updating an audience example." - }, - "UpdateBoostConfigEndpoint_Input": { - "type": "object", - "properties": { + "description": "The retrieval mode used by the distilling campaign to select rapids for users.\n Defaults to Shuffled." + }, "minDistillingForGlobalBoost": { "type": "integer", - "description": "Minimum number of distilling users required to activate global boost.", + "description": "Minimum distilling users before disabling global boost.\n Defaults to 200. Admin-only override.", "format": "int32", "nullable": true }, "minGraduatedForDistillingBoost": { "type": "integer", - "description": "Minimum number of graduated users required to activate distilling boost.", + "description": "Minimum graduated users before disabling distilling boost.\n Defaults to 100. Admin-only override.", "format": "int32", "nullable": true } } }, - "UpdateBoostConfigEndpoint_Output": { - "type": "object", - "properties": { - "recalculationId": { - "type": "string", - "description": "The id of the audience state recalculation dispatched by this update.\n Boost-only updates do not trigger a recalculation, so this is typically null.", - "nullable": true - } - } - }, - "AudienceBoost": { + "CreateAudienceEndpoint_Output": { "required": [ - "externalAudienceId", - "level" + "audienceId" ], "type": "object", "properties": { - "externalAudienceId": { - "type": "integer", - "format": "int32" - }, - "level": { - "type": "integer", - "format": "int32" + "audienceId": { + "type": "string", + "description": "The unique identifier of the newly created audience." } } }, - "BoostingControlMode": { - "enum": [ - "Manual", - "Automatic" - ] - }, - "BoostingProfile": { + "CreateFilteredAudienceEndpoint_Input": { "required": [ - "globalBoostLevel", - "prospectBlacklist", - "distillingBoosts", - "labelingBoosts" + "filter" ], "type": "object", "properties": { - "globalBoostLevel": { - "type": "integer", - "format": "int32" - }, - "minAutoAdjustLevel": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "maxAutoAdjustLevel": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "languageBoosts": { + "filter": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "$ref": "#/components/schemas/IAudienceFilter" } ], - "deprecated": true - }, - "prospectBlacklist": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - }, - "distillingBoosts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceBoost" - } - }, - "labelingBoosts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceBoost" - } + "description": "The filter that restricts the base audience's graduates to a subset (e.g. by language,\n country or demographic value). Multiple criteria can be combined with And / Or / Not." } } }, - "BoostMode": { - "enum": [ - "Automatic", - "Manual" - ] - }, - "BoostStatus": { - "enum": [ - "Active", - "Inactive", - "Partial", - "Unknown" - ] - }, - "CampaignStatus": { - "enum": [ - "Created", - "Preview", - "Active", - "Analysis", - "Paused", - "Completed", - "SpendLimited" - ] - }, - "ChangeBoostEndpoint_Input": { + "CreateFilteredAudienceEndpoint_Output": { "required": [ - "isManual" + "audienceId" ], "type": "object", "properties": { - "isManual": { - "type": "boolean", - "description": "Whether the manual overwrite should be applied." - }, - "isActive": { - "type": "boolean", - "description": "Whether the boost is active. Deprecated in favor of Level.", - "deprecated": true - }, - "level": { - "type": "integer", - "description": "The boost level. Takes precedence over IsActive when set.", - "format": "int32", - "nullable": true + "audienceId": { + "type": "string", + "description": "The unique identifier of the filtered audience. Use this id in job creation." } } }, - "ComparisonOperator": { - "enum": [ - "Equal", - "NotEqual", - "LessThan", - "LessThanOrEqual", - "GreaterThan", - "GreaterThanOrEqual" - ] - }, - "CreateOwnerTierOverrideEndpoint_Input": { - "required": [ - "organizationId" - ], + "DeleteAudienceExampleEndpoint_Output": { "type": "object", "properties": { - "organizationId": { + "recalculationId": { "type": "string", - "description": "The id of the organization this override applies to." - }, - "priorityOverride": { - "type": "integer", - "description": "The priority matching owners' jobs are created with. Null for no priority override.", - "format": "int32", - "nullable": true - }, - "boostOverride": { - "type": "integer", - "description": "The global boost level matching owners' campaigns are created with (0-10). Null for none.", - "format": "int32", + "description": "The id of the audience state recalculation dispatched as a result of this deletion.\n Null when the deletion cannot transition any user's state (e.g. the audience still has\n more examples than MaxDistillingResponses + 1 after the delete).", "nullable": true } } }, - "CreateOwnerTierOverrideEndpoint_Output": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The id of the created override." - } - } + "DeviceType": { + "enum": [ + "Unknown", + "Phone", + "Tablet" + ] }, - "CreateProgramCampaignEndpoint_Input": { - "required": [ - "name", - "priority", - "rootNodeId", - "nodes", - "maxRapids", - "maxDurationSeconds" - ], + "ExampleBoxShape": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the campaign." - }, - "priority": { - "type": "integer", - "description": "The priority weight the campaign competes with for sessions.", - "format": "int32" - }, - "rootNodeId": { - "type": "string", - "description": "The node the program's evaluation enters at." + "xMin": { + "type": "number", + "format": "double", + "nullable": true }, - "nodes": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IProgramNode" - } - } - ], - "description": "The program's decision graph, keyed by node id." + "yMin": { + "type": "number", + "format": "double", + "nullable": true }, - "maxRapids": { - "type": "integer", - "description": "The session ends after this many counted responses.", - "format": "int32" + "xMax": { + "type": "number", + "format": "double", + "nullable": true }, - "maxDurationSeconds": { - "type": "integer", - "description": "The session ends after this many seconds.", - "format": "int32" + "yMax": { + "type": "number", + "format": "double", + "nullable": true } } }, - "CreateProgramCampaignEndpoint_Output": { + "ExampleCategory": { "required": [ - "campaignId" + "label", + "value" ], "type": "object", "properties": { - "campaignId": { - "type": "string", - "description": "The id of the created campaign." + "label": { + "type": "string" + }, + "value": { + "type": "string" } } }, - "GetBoostInsightsEndpoint_AudienceOutput": { + "ExampleScrubRange": { "required": [ - "externalAudienceId", - "contributors" + "start", + "end" ], "type": "object", "properties": { - "externalAudienceId": { + "start": { "type": "integer", "format": "int32" }, - "contributors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_ContributorOutput" - } + "end": { + "type": "integer", + "format": "int32" } } }, - "GetBoostInsightsEndpoint_ContributorOutput": { + "ExampleTranscriptionWord": { "required": [ - "campaignId", - "campaignName" + "word", + "wordIndex" ], "type": "object", "properties": { - "campaignId": { + "word": { "type": "string" }, - "campaignName": { - "type": "string" - } - } - }, - "GetBoostInsightsEndpoint_GlobalBoostOutput": { - "required": [ - "effectiveLevel", - "contributors" - ], - "type": "object", - "properties": { - "effectiveLevel": { + "wordIndex": { "type": "integer", "format": "int32" - }, - "contributors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LevelContributorOutput" - } } } }, - "GetBoostInsightsEndpoint_LanguageBoostOutput": { + "ExampleVisibility": { + "enum": [ + "Private", + "Public" + ] + }, + "ExistingAssetInput": { "required": [ - "language", - "contributors" + "name" ], "type": "object", "properties": { - "language": { + "name": { "type": "string" }, - "contributors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_ContributorOutput" - } + "metadata": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/MetadataInputCollection" + } + ], + "nullable": true + }, + "identifier": { + "type": "string", + "nullable": true } } }, - "GetBoostInsightsEndpoint_LevelContributorOutput": { + "FeatureFlag": { "required": [ - "campaignId", - "campaignName", - "level" + "key", + "value" ], "type": "object", "properties": { - "campaignId": { + "key": { "type": "string" }, - "campaignName": { + "value": { "type": "string" - }, - "level": { - "type": "integer", - "format": "int32" } } }, - "GetBoostInsightsEndpoint_LeveledAudienceOutput": { + "FileType": { + "enum": [ + "Unknown", + "Image", + "Video", + "Audio" + ] + }, + "GetAudienceByIdEndpoint_Output": { "required": [ - "externalAudienceId", - "effectiveLevel", - "contributors" + "id", + "baseAudienceId", + "name", + "status", + "qualifiedUserCount", + "filters", + "createdAt", + "ownerId", + "ownerMail", + "organizationId", + "isPublic", + "isDistilling", + "distillingCampaignId", + "graduationRule", + "distillingRetrievalMode", + "boostLevel" ], "type": "object", "properties": { - "externalAudienceId": { + "id": { + "type": "string", + "description": "The unique identifier of the audience." + }, + "baseAudienceId": { + "type": "string", + "description": "The audience that backs this entry. Equals id for a regular audience; for a\n filtered audience it points to the audience the filter is applied on top of." + }, + "filter": { + "allOf": [ + { + "$ref": "#/components/schemas/IAudienceFilter" + } + ], + "description": "The filter applied on top of the base audience. Null for a regular audience — a\n non-null value is the sole signal that this is a filtered view. Every other field\n describes the base audience, since a filtered view inherits its configuration and has\n no user counts of its own." + }, + "name": { + "type": "string", + "description": "The name of the audience." + }, + "description": { + "type": "string", + "description": "The markdown-supported description of the audience.", + "nullable": true + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/AudienceStatus" + } + ], + "description": "The current status of the audience." + }, + "qualifiedUserCount": { "type": "integer", - "format": "int32" + "description": "The number of users that have qualified for this audience.", + "format": "int64" }, - "effectiveLevel": { + "filters": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAudienceFilter" + } + } + ], + "description": "The filters applied to this audience." + }, + "logo": { + "type": "string", + "description": "The URL of the audience logo, if any.", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the audience was created.", + "format": "date-time" + }, + "ownerId": { + "type": "string", + "description": "The unique identifier of the audience owner.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The email of the audience owner." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "isPublic": { + "type": "boolean", + "description": "Whether the audience is publicly visible." + }, + "isDistilling": { + "type": "boolean", + "description": "Whether the audience is currently distilling users." + }, + "distillingCampaignId": { + "type": "string", + "description": "The id of the distilling campaign associated with the audience." + }, + "minGraduatedForDistillingBoost": { + "type": "integer", + "description": "Minimum graduated users before disabling distilling boost.", + "format": "int32", + "nullable": true + }, + "minDistillingForGlobalBoost": { + "type": "integer", + "description": "Minimum distilling users before disabling global boost.", + "format": "int32", + "nullable": true + }, + "graduationRule": { + "allOf": [ + { + "$ref": "#/components/schemas/IGraduationRule" + } + ], + "description": "The rule this audience uses to graduate users — a score-threshold rule or a\n task-accuracy rule." + }, + "maxDistillingResponses": { + "type": "integer", + "description": "Maximum responses before user exits the distilling campaign.", + "format": "uint32", + "nullable": true + }, + "dropMinResponses": { + "type": "integer", + "description": "Minimum responses before the drop score check applies.", + "format": "uint32", + "nullable": true + }, + "dropScore": { + "type": "number", + "description": "Score floor - users below this score exit the distilling campaign.", + "format": "double", + "nullable": true + }, + "maxDistillingSessions": { + "type": "integer", + "description": "Maximum sessions before user exits the distilling campaign.", + "format": "uint32", + "nullable": true + }, + "inactivityDropDays": { "type": "integer", - "format": "int32" + "description": "Number of days of inactivity before a distilling user is dropped.", + "format": "uint32", + "nullable": true }, - "contributors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LevelContributorOutput" - } - } - } - }, - "GetBoostInsightsEndpoint_Output": { - "required": [ - "mode", - "manualOverrideLevel", - "globalBoost", - "prospectBlacklist", - "distillingBoosts", - "labelingBoosts" - ], - "type": "object", - "properties": { - "mode": { - "allOf": [ - { - "$ref": "#/components/schemas/BoostMode" - } - ], - "description": "The current boost mode." + "minSubmissionRate": { + "type": "number", + "description": "Minimum submission rate before a user is dropped.", + "format": "double", + "nullable": true }, - "manualOverrideLevel": { + "minSessionsForSubmissionRate": { "type": "integer", - "description": "The manual override level, if manual mode is active.", - "format": "int32", + "description": "Minimum number of sessions before the submission rate check applies.", + "format": "uint32", "nullable": true }, - "globalBoost": { - "allOf": [ - { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_GlobalBoostOutput" - } - ], - "description": "Global boost insight with contributing campaigns." + "minSubmissionRateGraduated": { + "type": "number", + "description": "Minimum submission rate for graduated users.", + "format": "double", + "nullable": true }, - "languageBoosts": { + "distillingRetrievalMode": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LanguageBoostOutput" - }, - "nullable": true + "$ref": "#/components/schemas/RetrievalMode" } ], - "description": "Language-specific boost insights.", - "deprecated": true + "description": "The retrieval mode used by the distilling campaign to select rapids for users." }, - "audienceBoosts": { + "boostLevel": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_AudienceOutput" - }, - "nullable": true + "$ref": "#/components/schemas/BoostLevel" } ], - "description": "Audience boost insights.", - "deprecated": true + "description": "The current boost level applied to the audience." }, - "prospectBlacklist": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_AudienceOutput" - } - } - ], - "description": "Prospect blacklist insights." + "randomAdmissionProbability": { + "type": "number", + "description": "The probability of admitting a random user to the audience.", + "format": "double", + "nullable": true }, - "distillingBoosts": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LeveledAudienceOutput" - } - } - ], - "description": "Distilling boost insights." + "health": { + "type": "number", + "description": "The health score of the audience.", + "format": "double", + "nullable": true }, - "labelingBoosts": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LeveledAudienceOutput" - } - } - ], - "description": "Labeling boost insights." + "graduated": { + "type": "integer", + "description": "The number of graduated users.", + "format": "int64" + }, + "dropped": { + "type": "integer", + "description": "The number of dropped users.", + "format": "int64" } } }, - "GetBoostStatusEndpoint_Output": { + "GetAudienceInactivitySyncByIdEndpoint_Output": { "required": [ - "status", - "mode", - "activeCampaigns", - "inactiveCampaigns", - "unknownCampaigns" + "id", + "audienceId", + "state", + "phase", + "cutoff", + "processedCount", + "changedCount", + "createdAt" ], "type": "object", "properties": { - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/BoostStatus" - } - ], - "description": "The current boost status." + "id": { + "type": "string", + "description": "The unique identifier of the inactivity sync." }, - "mode": { + "audienceId": { + "type": "string", + "description": "The audience this inactivity sync belongs to." + }, + "state": { "allOf": [ { - "$ref": "#/components/schemas/BoostMode" + "$ref": "#/components/schemas/AudienceInactivitySyncState" } ], - "description": "The current boost mode." + "description": "The current state of the inactivity sync." }, - "activeCampaigns": { + "phase": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/AudienceInactivitySyncPhase" } ], - "description": "The list of active campaign identifiers." + "description": "The current phase within the inactivity sync lifecycle." }, - "inactiveCampaigns": { + "cutoff": { + "type": "string", + "description": "The cutoff captured at run creation time. Users with last_seen_at older than this are marked inactive.", + "format": "date-time" + }, + "lastProcessedUserId": { + "type": "string", + "description": "The id of the last user that was processed (progress cursor).", + "nullable": true + }, + "processedCount": { + "type": "integer", + "description": "The number of users processed so far.", + "format": "int64" + }, + "changedCount": { + "type": "integer", + "description": "The number of users whose state was changed by the sync.", + "format": "int64" + }, + "errorMessage": { + "type": "string", + "description": "Error message populated when the sync transitioned to Failed.", + "nullable": true + }, + "startedAt": { + "type": "string", + "description": "When the sync began processing (null while still Pending).", + "format": "date-time", + "nullable": true + }, + "lastHeartbeatAt": { + "type": "string", + "description": "Timestamp of the last heartbeat received from the worker.", + "format": "date-time", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "When the sync reached a terminal state (Completed, Failed, Aborted).", + "format": "date-time", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "When the sync was created.", + "format": "date-time" + } + } + }, + "GetAudienceStateRecalculationByIdEndpoint_Output": { + "required": [ + "id", + "audienceId", + "state", + "phase", + "processedCount", + "changedCount", + "createdAt" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the recalculation." + }, + "audienceId": { + "type": "string", + "description": "The audience this recalculation belongs to." + }, + "state": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/AudienceStateRecalculationState" } ], - "description": "The list of inactive campaign identifiers." + "description": "The current state of the recalculation." }, - "unknownCampaigns": { + "phase": { "allOf": [ { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } + "$ref": "#/components/schemas/AudienceStateRecalculationPhase" } ], - "description": "The list of unknown campaign identifiers." + "description": "The current phase within the recalculation lifecycle." + }, + "lastProcessedUserId": { + "type": "string", + "description": "The id of the last user that was processed (progress cursor).", + "nullable": true + }, + "processedCount": { + "type": "integer", + "description": "The number of users processed so far.", + "format": "int64" + }, + "changedCount": { + "type": "integer", + "description": "The number of users whose state was changed by the recalculation.", + "format": "int64" + }, + "errorMessage": { + "type": "string", + "description": "Error message populated when the recalculation transitioned to Failed.", + "nullable": true + }, + "startedAt": { + "type": "string", + "description": "When the recalculation began processing (null while still Pending).", + "format": "date-time", + "nullable": true + }, + "lastHeartbeatAt": { + "type": "string", + "description": "Timestamp of the last heartbeat received from the worker.", + "format": "date-time", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "When the recalculation reached a terminal state (Completed, Failed, Aborted).", + "format": "date-time", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "When the recalculation was created.", + "format": "date-time" } } }, - "GetCampaignByIdEndpoint_ICampaignDetails": { + "GetAudienceUserStateMetricsResult": { "required": [ - "_t" + "usersPerState" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_RoutedCampaignDetails" - }, - { - "$ref": "#/components/schemas/GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_ProgramCampaignDetails" - } - ], - "description": "A campaign's details, identified by a discriminator. Implementations describe the\n type-specific configuration: a routed campaign's selections or a program campaign's\n stream program.", - "discriminator": { - "propertyName": "_t", - "mapping": { - "RoutedCampaign": "#/components/schemas/GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_RoutedCampaignDetails", - "ProgramCampaign": "#/components/schemas/GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_ProgramCampaignDetails" + "properties": { + "usersPerState": { + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } } } }, - "GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_ProgramCampaignDetails": { + "GetLatestAudienceInactivitySyncEndpoint_Output": { "required": [ "id", - "name", - "status", - "priority", - "boostingProfile", - "boostingControlMode", - "hasBooster", - "boostLevel", - "stickyConfig", - "filters", - "featureFlags", - "ownerMail", - "organizationId", - "createdAt", - "version", - "rootNodeId", - "nodes", - "maxRapids", - "maxDurationSeconds", - "_t" + "audienceId", + "state", + "phase", + "cutoff", + "processedCount", + "changedCount", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ProgramCampaign" - ], - "type": "string" - }, "id": { "type": "string", - "description": "The unique identifier of the campaign." + "description": "The unique identifier of the inactivity sync." }, - "name": { + "audienceId": { "type": "string", - "description": "The name of the campaign." + "description": "The audience this inactivity sync belongs to." }, - "status": { + "state": { "allOf": [ { - "$ref": "#/components/schemas/CampaignStatus" + "$ref": "#/components/schemas/AudienceInactivitySyncState" } ], - "description": "The current status of the campaign." - }, - "priority": { - "type": "integer", - "description": "The priority level of the campaign.", - "format": "int32" + "description": "The current state of the inactivity sync." }, - "boostingProfile": { + "phase": { "allOf": [ { - "$ref": "#/components/schemas/BoostingProfile" + "$ref": "#/components/schemas/AudienceInactivitySyncPhase" } ], - "description": "The boosting profile configuration." + "description": "The current phase within the inactivity sync lifecycle." }, - "boostingControlMode": { - "allOf": [ - { - "$ref": "#/components/schemas/BoostingControlMode" - } - ], - "description": "The boosting control mode." + "cutoff": { + "type": "string", + "description": "The cutoff captured at run creation time. Users with last_seen_at older than this are marked inactive.", + "format": "date-time" }, - "hasBooster": { - "type": "boolean", - "description": "Whether the campaign has a booster." + "lastProcessedUserId": { + "type": "string", + "description": "The id of the last user that was processed (progress cursor).", + "nullable": true }, - "boostLevel": { + "processedCount": { "type": "integer", - "description": "The campaign's effective boost level (0-10). 0 when no boost is active.\n Lets clients render and edit the level without unpacking the boosting profile.", - "format": "int32" + "description": "The number of users processed so far.", + "format": "int64" }, - "requiresBooster": { - "type": "boolean", - "description": "Whether the campaign requires a booster.", - "deprecated": true + "changedCount": { + "type": "integer", + "description": "The number of users whose state was changed by the sync.", + "format": "int64" }, - "stickyConfig": { - "allOf": [ - { - "$ref": "#/components/schemas/StickyConfig" - } - ], - "description": "The sticky behavior configuration." + "errorMessage": { + "type": "string", + "description": "Error message populated when the sync transitioned to Failed.", + "nullable": true }, - "filters": { + "startedAt": { + "type": "string", + "description": "When the sync began processing (null while still Pending).", + "format": "date-time", + "nullable": true + }, + "lastHeartbeatAt": { + "type": "string", + "description": "Timestamp of the last heartbeat received from the worker.", + "format": "date-time", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "When the sync reached a terminal state (Completed, Failed, Aborted).", + "format": "date-time", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "When the sync was created.", + "format": "date-time" + } + } + }, + "GetLatestAudienceStateRecalculationEndpoint_Output": { + "required": [ + "id", + "audienceId", + "state", + "phase", + "processedCount", + "changedCount", + "createdAt" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the recalculation." + }, + "audienceId": { + "type": "string", + "description": "The audience this recalculation belongs to." + }, + "state": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/ICampaignFilter" - } + "$ref": "#/components/schemas/AudienceStateRecalculationState" } ], - "description": "The targeting filters for this campaign." + "description": "The current state of the recalculation." }, - "featureFlags": { + "phase": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } + "$ref": "#/components/schemas/AudienceStateRecalculationPhase" } ], - "description": "The feature flags configured for this campaign." + "description": "The current phase within the recalculation lifecycle." + }, + "lastProcessedUserId": { + "type": "string", + "description": "The id of the last user that was processed (progress cursor).", + "nullable": true + }, + "processedCount": { + "type": "integer", + "description": "The number of users processed so far.", + "format": "int64" + }, + "changedCount": { + "type": "integer", + "description": "The number of users whose state was changed by the recalculation.", + "format": "int64" + }, + "errorMessage": { + "type": "string", + "description": "Error message populated when the recalculation transitioned to Failed.", + "nullable": true + }, + "startedAt": { + "type": "string", + "description": "When the recalculation began processing (null while still Pending).", + "format": "date-time", + "nullable": true }, - "ownerMail": { + "lastHeartbeatAt": { "type": "string", - "description": "The email of the campaign owner." + "description": "Timestamp of the last heartbeat received from the worker.", + "format": "date-time", + "nullable": true }, - "organizationId": { + "completedAt": { "type": "string", - "description": "The id of the organization that owns the campaign." + "description": "When the recalculation reached a terminal state (Completed, Failed, Aborted).", + "format": "date-time", + "nullable": true }, "createdAt": { "type": "string", - "description": "The timestamp when the campaign was created.", + "description": "When the recalculation was created.", "format": "date-time" + } + } + }, + "IAsset": { + "required": [ + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAssetFileAsset" }, - "version": { - "type": "integer", - "description": "The program's current version, for optimistic concurrency on save.", - "format": "int32" + { + "$ref": "#/components/schemas/IAssetMultiAsset" }, - "rootNodeId": { - "type": "string", - "description": "The node the program's evaluation enters at." + { + "$ref": "#/components/schemas/IAssetNullAsset" }, - "nodes": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IProgramNode" - } - } + { + "$ref": "#/components/schemas/IAssetTextAsset" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "FileAsset": "#/components/schemas/IAssetFileAsset", + "MultiAsset": "#/components/schemas/IAssetMultiAsset", + "NullAsset": "#/components/schemas/IAssetNullAsset", + "TextAsset": "#/components/schemas/IAssetTextAsset" + } + } + }, + "IAssetFileAsset": { + "required": [ + "fileName", + "metadata", + "identifier", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "FileAsset" ], - "description": "The program's decision graph, keyed by node id." + "type": "string" }, - "maxRapids": { - "type": "integer", - "description": "The session ends after this many counted responses.", - "format": "int32" + "fileName": { + "type": "string" }, - "maxDurationSeconds": { - "type": "integer", - "description": "The session ends after this many seconds.", - "format": "int32" + "metadata": { + "$ref": "#/components/schemas/MetadataModelCollection" + }, + "identifier": { + "type": "string" } - }, - "description": "A program campaign: its sessions stream their rapids, driven by a stream program." + } }, - "GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_RoutedCampaignDetails": { + "IAssetInput": { + "required": [ + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAssetInputExistingAssetInput" + }, + { + "$ref": "#/components/schemas/IAssetInputMultiAssetInput" + }, + { + "$ref": "#/components/schemas/IAssetInputTextAssetInput" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "ExistingAssetInput": "#/components/schemas/IAssetInputExistingAssetInput", + "MultiAssetInput": "#/components/schemas/IAssetInputMultiAssetInput", + "TextAssetInput": "#/components/schemas/IAssetInputTextAssetInput" + } + } + }, + "IAssetInputExistingAssetInput": { "required": [ - "id", "name", - "status", - "priority", - "boostingProfile", - "boostingControlMode", - "hasBooster", - "boostLevel", - "stickyConfig", - "filters", - "selections", - "featureFlags", - "ownerMail", - "organizationId", - "createdAt", "_t" ], "properties": { "_t": { "enum": [ - "RoutedCampaign" + "ExistingAssetInput" ], "type": "string" }, - "id": { - "type": "string", - "description": "The unique identifier of the campaign." - }, "name": { - "type": "string", - "description": "The name of the campaign." + "type": "string" }, - "status": { - "allOf": [ + "metadata": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/CampaignStatus" + "$ref": "#/components/schemas/MetadataInputCollection" } ], - "description": "The current status of the campaign." - }, - "priority": { - "type": "integer", - "description": "The priority level of the campaign.", - "format": "int32" + "nullable": true }, - "boostingProfile": { - "allOf": [ - { - "$ref": "#/components/schemas/BoostingProfile" - } + "identifier": { + "type": "string", + "nullable": true + } + } + }, + "IAssetInputMultiAssetInput": { + "required": [ + "assets", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "MultiAssetInput" ], - "description": "The boosting profile configuration." + "type": "string" }, - "boostingControlMode": { - "allOf": [ + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAssetInput" + } + }, + "metadata": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/BoostingControlMode" + "$ref": "#/components/schemas/MetadataInputCollection" } ], - "description": "The boosting control mode." - }, - "hasBooster": { - "type": "boolean", - "description": "Whether the campaign has a booster." + "nullable": true }, - "boostLevel": { - "type": "integer", - "description": "The campaign's effective boost level (0-10). 0 when no boost is active.\n Lets clients render and edit the level without unpacking the boosting profile.", - "format": "int32" + "identifier": { + "type": "string", + "nullable": true + } + } + }, + "IAssetInputTextAssetInput": { + "required": [ + "text", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "TextAssetInput" + ], + "type": "string" }, - "requiresBooster": { - "type": "boolean", - "description": "Whether the campaign requires a booster.", - "deprecated": true + "text": { + "type": "string" }, - "stickyConfig": { - "allOf": [ + "metadata": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/StickyConfig" + "$ref": "#/components/schemas/MetadataInputCollection" } ], - "description": "The sticky behavior configuration." + "nullable": true }, - "filters": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/ICampaignFilter" - } - } + "identifier": { + "type": "string", + "nullable": true + } + } + }, + "IAssetMultiAsset": { + "required": [ + "assets", + "metadata", + "identifier", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "MultiAsset" ], - "description": "The targeting filters for this campaign." + "type": "string" }, - "selections": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/ICampaignSelection" - } - } - ], - "description": "The rapid selections for this campaign." + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAsset" + } }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "The feature flags configured for this campaign." + "metadata": { + "$ref": "#/components/schemas/MetadataModelCollection" }, - "ownerMail": { - "type": "string", - "description": "The email of the campaign owner." + "identifier": { + "type": "string" + } + } + }, + "IAssetNullAsset": { + "required": [ + "metadata", + "identifier", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "NullAsset" + ], + "type": "string" }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the campaign." + "metadata": { + "$ref": "#/components/schemas/MetadataModelCollection" }, - "createdAt": { - "type": "string", - "description": "The timestamp when the campaign was created.", - "format": "date-time" + "identifier": { + "type": "string" } - }, - "description": "A routed campaign: its rapids are served from a fixed selection list." + } }, - "GetCampaignCacheEndpoint_CampaignEntry": { + "IAssetTextAsset": { "required": [ - "id", - "name", - "status", - "priority", - "filterCount", - "selectionCount", - "userScoreDimensionCount", - "featureFlagCount", - "rateLimitCount", - "isPreviewEnabled", - "boostingControlMode" + "text", + "metadata", + "identifier", + "_t" ], - "type": "object", "properties": { - "id": { + "_t": { + "enum": [ + "TextAsset" + ], "type": "string" }, - "name": { + "text": { "type": "string" }, - "status": { - "$ref": "#/components/schemas/CampaignStatus" + "metadata": { + "$ref": "#/components/schemas/MetadataModelCollection" }, - "priority": { - "type": "integer", - "format": "int32" + "identifier": { + "type": "string" + } + } + }, + "IAudienceFilter": { + "required": [ + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAudienceFilterAndAudienceFilter" }, - "filterCount": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IAudienceFilterCountryAudienceFilter" }, - "selectionCount": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IAudienceFilterDemographicAudienceFilter" }, - "userScoreDimensionCount": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IAudienceFilterDeviceAudienceFilter" }, - "featureFlagCount": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IAudienceFilterLanguageAudienceFilter" }, - "rateLimitCount": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IAudienceFilterNotAudienceFilter" }, - "isPreviewEnabled": { - "type": "boolean" + { + "$ref": "#/components/schemas/IAudienceFilterOrAudienceFilter" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AndFilter": "#/components/schemas/IAudienceFilterAndAudienceFilter", + "CountryFilter": "#/components/schemas/IAudienceFilterCountryAudienceFilter", + "DemographicFilter": "#/components/schemas/IAudienceFilterDemographicAudienceFilter", + "DeviceFilter": "#/components/schemas/IAudienceFilterDeviceAudienceFilter", + "LanguageFilter": "#/components/schemas/IAudienceFilterLanguageAudienceFilter", + "NotFilter": "#/components/schemas/IAudienceFilterNotAudienceFilter", + "OrFilter": "#/components/schemas/IAudienceFilterOrAudienceFilter" + } + } + }, + "IAudienceFilterAndAudienceFilter": { + "required": [ + "filters", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "AndFilter" + ], + "type": "string" }, - "boostingControlMode": { - "$ref": "#/components/schemas/BoostingControlMode" + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAudienceFilter" + } } } }, - "GetCampaignCacheEndpoint_Output": { + "IAudienceFilterCountryAudienceFilter": { "required": [ - "count", - "campaigns" + "countries", + "_t" ], - "type": "object", "properties": { - "count": { - "type": "integer", - "description": "The total number of cached campaigns.", - "format": "int32" + "_t": { + "enum": [ + "CountryFilter" + ], + "type": "string" }, - "campaigns": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetCampaignCacheEndpoint_CampaignEntry" - } - } + "countries": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IAudienceFilterDemographicAudienceFilter": { + "required": [ + "identifier", + "values", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "DemographicFilter" ], - "description": "The list of cached campaign summaries." + "type": "string" + }, + "identifier": { + "type": "string" + }, + "values": { + "type": "array", + "items": { + "type": "string" + } } } }, - "GetFastBidMultiplierEndpoint_Output": { + "IAudienceFilterDeviceAudienceFilter": { "required": [ - "externalCampaignId", - "bidMultiplierValue" + "deviceTypes", + "_t" ], - "type": "object", "properties": { - "externalCampaignId": { - "type": "integer", - "description": "The external campaign id reported by the downstream system.", - "format": "int32" + "_t": { + "enum": [ + "DeviceFilter" + ], + "type": "string" + }, + "deviceTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceType" + } + } + } + }, + "IAudienceFilterLanguageAudienceFilter": { + "required": [ + "languages", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "LanguageFilter" + ], + "type": "string" }, - "bidMultiplierValue": { - "type": "number", - "description": "The current bid multiplier reported for the campaign.", - "format": "double" + "languages": { + "type": "array", + "items": { + "type": "string" + } } } }, - "GetOrganizationOwnerTierEndpoint_Output": { + "IAudienceFilterNotAudienceFilter": { "required": [ - "organizationId", - "priority", - "globalBoostLevel" + "filter", + "_t" ], - "type": "object", "properties": { - "organizationId": { - "type": "string", - "description": "The id of the organization the tier applies to." - }, - "priority": { - "type": "integer", - "description": "The priority the organization's campaigns are created with.", - "format": "int32" - }, - "globalBoostLevel": { - "type": "integer", - "description": "The global boost level the organization's campaigns are created with.", - "format": "int32" - }, - "priorityOverride": { - "type": "integer", - "description": "The priority from the matching override, or null when the default applies.", - "format": "int32", - "nullable": true + "_t": { + "enum": [ + "NotFilter" + ], + "type": "string" }, - "boostOverride": { - "type": "integer", - "description": "The boost level from the matching override, or null when the default applies.", - "format": "int32", - "nullable": true + "filter": { + "$ref": "#/components/schemas/IAudienceFilter" } } }, - "GetUserScoreCacheEndpoint_Output": { + "IAudienceFilterOrAudienceFilter": { "required": [ - "count", - "scores" + "filters", + "_t" ], - "type": "object", "properties": { - "count": { - "type": "integer", - "description": "The total number of cached user scores.", - "format": "int32" - }, - "scores": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } + "_t": { + "enum": [ + "OrFilter" ], - "description": "The cached dimension-to-score mappings." + "type": "string" + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAudienceFilter" + } } } }, - "ICampaignFilter": { + "IExamplePayload": { "required": [ "_t" ], "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/ICampaignFilterAndFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterAudienceStateFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterCampaignCooldownFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterCampaignIdFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterCampaignSessionCountFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterCountryFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterDemographicFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterDeviceFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterDspFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterLanguageFilter" - }, - { - "$ref": "#/components/schemas/ICampaignFilterNewUserFilter" + "$ref": "#/components/schemas/IExamplePayloadClassifyExamplePayload" }, { - "$ref": "#/components/schemas/ICampaignFilterNotFilter" + "$ref": "#/components/schemas/IExamplePayloadCompareExamplePayload" }, { - "$ref": "#/components/schemas/ICampaignFilterOrFilter" + "$ref": "#/components/schemas/IExamplePayloadLineExamplePayload" }, { - "$ref": "#/components/schemas/ICampaignFilterResponseCountFilter" + "$ref": "#/components/schemas/IExamplePayloadLocateExamplePayload" }, { - "$ref": "#/components/schemas/ICampaignFilterUserActionRestrictionFilter" + "$ref": "#/components/schemas/IExamplePayloadScrubExamplePayload" }, { - "$ref": "#/components/schemas/ICampaignFilterUserScoreFilter" + "$ref": "#/components/schemas/IExamplePayloadTranscriptionExamplePayload" } ], "discriminator": { "propertyName": "_t", "mapping": { - "AndFilter": "#/components/schemas/ICampaignFilterAndFilter", - "AudienceStateFilter": "#/components/schemas/ICampaignFilterAudienceStateFilter", - "CampaignCooldownFilter": "#/components/schemas/ICampaignFilterCampaignCooldownFilter", - "CampaignIdFilter": "#/components/schemas/ICampaignFilterCampaignIdFilter", - "CampaignSessionCountFilter": "#/components/schemas/ICampaignFilterCampaignSessionCountFilter", - "CountryFilter": "#/components/schemas/ICampaignFilterCountryFilter", - "DemographicFilter": "#/components/schemas/ICampaignFilterDemographicFilter", - "DeviceFilter": "#/components/schemas/ICampaignFilterDeviceFilter", - "DspFilter": "#/components/schemas/ICampaignFilterDspFilter", - "LanguageFilter": "#/components/schemas/ICampaignFilterLanguageFilter", - "NewUserFilter": "#/components/schemas/ICampaignFilterNewUserFilter", - "NotFilter": "#/components/schemas/ICampaignFilterNotFilter", - "OrFilter": "#/components/schemas/ICampaignFilterOrFilter", - "ResponseCountFilter": "#/components/schemas/ICampaignFilterResponseCountFilter", - "UserActionRestrictionFilter": "#/components/schemas/ICampaignFilterUserActionRestrictionFilter", - "UserScoreFilter": "#/components/schemas/ICampaignFilterUserScoreFilter" + "ClassifyExamplePayload": "#/components/schemas/IExamplePayloadClassifyExamplePayload", + "CompareExamplePayload": "#/components/schemas/IExamplePayloadCompareExamplePayload", + "LineExamplePayload": "#/components/schemas/IExamplePayloadLineExamplePayload", + "LocateExamplePayload": "#/components/schemas/IExamplePayloadLocateExamplePayload", + "ScrubExamplePayload": "#/components/schemas/IExamplePayloadScrubExamplePayload", + "TranscriptionExamplePayload": "#/components/schemas/IExamplePayloadTranscriptionExamplePayload" } } }, - "ICampaignFilterAndFilter": { + "IExamplePayloadClassifyExamplePayload": { "required": [ - "filters", + "categories", + "title", "_t" ], "properties": { "_t": { "enum": [ - "AndFilter" + "ClassifyExamplePayload" ], "type": "string" }, - "filters": { + "categories": { "type": "array", "items": { - "$ref": "#/components/schemas/ICampaignFilter" + "$ref": "#/components/schemas/ExampleCategory" } + }, + "title": { + "type": "string" } } }, - "ICampaignFilterAudienceStateFilter": { + "IExamplePayloadCompareExamplePayload": { "required": [ - "audienceId", - "allowedStates", - "includeUnknownState", + "criteria", "_t" ], "properties": { "_t": { "enum": [ - "AudienceStateFilter" + "CompareExamplePayload" ], "type": "string" }, - "audienceId": { + "criteria": { "type": "string" - }, - "allowedStates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SimplifiedAudienceUserState" - } - }, - "includeUnknownState": { - "type": "boolean" } } }, - "ICampaignFilterCampaignCooldownFilter": { + "IExamplePayloadLineExamplePayload": { "required": [ - "cooldown", + "target", "_t" ], "properties": { "_t": { "enum": [ - "CampaignCooldownFilter" + "LineExamplePayload" ], "type": "string" }, - "cooldown": { - "$ref": "#/components/schemas/ICooldownDuration" + "target": { + "type": "string" } } }, - "ICampaignFilterCampaignIdFilter": { + "IExamplePayloadLocateExamplePayload": { "required": [ - "campaignIds", + "target", "_t" ], "properties": { "_t": { "enum": [ - "CampaignIdFilter" + "LocateExamplePayload" ], "type": "string" }, - "campaignIds": { - "type": "array", - "items": { - "type": "string" - } + "target": { + "type": "string" } } }, - "ICampaignFilterCampaignSessionCountFilter": { + "IExamplePayloadScrubExamplePayload": { "required": [ - "sessionCount", - "operator", + "target", "_t" ], "properties": { "_t": { "enum": [ - "CampaignSessionCountFilter" + "ScrubExamplePayload" ], "type": "string" }, - "sessionCount": { - "type": "integer", - "format": "uint32" - }, - "operator": { - "$ref": "#/components/schemas/ComparisonOperator" + "target": { + "type": "string" } } }, - "ICampaignFilterCountryFilter": { + "IExamplePayloadTranscriptionExamplePayload": { "required": [ - "countries", + "title", + "transcription", "_t" ], "properties": { "_t": { "enum": [ - "CountryFilter" + "TranscriptionExamplePayload" ], "type": "string" }, - "countries": { + "title": { + "type": "string" + }, + "transcription": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ExampleTranscriptionWord" } } } }, - "ICampaignFilterDemographicFilter": { + "IExampleTruth": { "required": [ - "identifier", - "values", "_t" ], - "properties": { - "_t": { - "enum": [ - "DemographicFilter" - ], - "type": "string" + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IExampleTruthClassifyExampleTruth" }, - "identifier": { - "type": "string" + { + "$ref": "#/components/schemas/IExampleTruthCompareExampleTruth" }, - "values": { - "type": "array", - "items": { - "type": "string" - } + { + "$ref": "#/components/schemas/IExampleTruthLineExampleTruth" + }, + { + "$ref": "#/components/schemas/IExampleTruthLocateExampleTruth" + }, + { + "$ref": "#/components/schemas/IExampleTruthScrubExampleTruth" + }, + { + "$ref": "#/components/schemas/IExampleTruthTranscriptionExampleTruth" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "ClassifyExampleTruth": "#/components/schemas/IExampleTruthClassifyExampleTruth", + "CompareExampleTruth": "#/components/schemas/IExampleTruthCompareExampleTruth", + "LineExampleTruth": "#/components/schemas/IExampleTruthLineExampleTruth", + "LocateExampleTruth": "#/components/schemas/IExampleTruthLocateExampleTruth", + "ScrubExampleTruth": "#/components/schemas/IExampleTruthScrubExampleTruth", + "TranscriptionExampleTruth": "#/components/schemas/IExampleTruthTranscriptionExampleTruth" } } }, - "ICampaignFilterDeviceFilter": { + "IExampleTruthClassifyExampleTruth": { "required": [ - "deviceTypes", + "correctCategories", "_t" ], "properties": { "_t": { "enum": [ - "DeviceFilter" + "ClassifyExampleTruth" ], "type": "string" }, - "deviceTypes": { + "correctCategories": { "type": "array", "items": { - "$ref": "#/components/schemas/DeviceType" + "type": "string" } } } }, - "ICampaignFilterDspFilter": { + "IExampleTruthCompareExampleTruth": { "required": [ - "dspNames", + "winnerId", "_t" ], "properties": { "_t": { "enum": [ - "DspFilter" + "CompareExampleTruth" ], "type": "string" }, - "dspNames": { - "type": "array", - "items": { - "type": "string" - } + "winnerId": { + "type": "string" } } }, - "ICampaignFilterLanguageFilter": { + "IExampleTruthLineExampleTruth": { "required": [ - "languages", "_t" ], "properties": { "_t": { "enum": [ - "LanguageFilter" + "LineExampleTruth" ], "type": "string" }, - "languages": { + "boundingBoxes": { "type": "array", "items": { - "type": "string" - } + "$ref": "#/components/schemas/ExampleBoxShape" + }, + "nullable": true + }, + "requiredPrecision": { + "type": "number", + "format": "double", + "nullable": true + }, + "requiredCompleteness": { + "type": "number", + "format": "double", + "nullable": true } } }, - "ICampaignFilterNewUserFilter": { + "IExampleTruthLocateExampleTruth": { "required": [ + "boundingBoxes", "_t" ], "properties": { "_t": { "enum": [ - "NewUserFilter" + "LocateExampleTruth" ], "type": "string" + }, + "boundingBoxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExampleBoxShape" + } + }, + "requiredPrecision": { + "type": "number", + "format": "double", + "nullable": true + }, + "requiredCompleteness": { + "type": "number", + "format": "double", + "nullable": true } } }, - "ICampaignFilterNotFilter": { + "IExampleTruthScrubExampleTruth": { "required": [ - "filter", + "validRanges", "_t" ], "properties": { "_t": { "enum": [ - "NotFilter" + "ScrubExampleTruth" ], "type": "string" }, - "filter": { - "$ref": "#/components/schemas/ICampaignFilter" + "validRanges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExampleScrubRange" + } } } }, - "ICampaignFilterOrFilter": { + "IExampleTruthTranscriptionExampleTruth": { "required": [ - "filters", + "correctWords", "_t" ], "properties": { "_t": { "enum": [ - "OrFilter" + "TranscriptionExampleTruth" ], "type": "string" }, - "filters": { + "correctWords": { "type": "array", "items": { - "$ref": "#/components/schemas/ICampaignFilter" + "$ref": "#/components/schemas/ExampleTranscriptionWord" } + }, + "strictGrading": { + "type": "boolean", + "nullable": true + }, + "requiredPrecision": { + "type": "number", + "format": "double", + "nullable": true + }, + "requiredCompleteness": { + "type": "number", + "format": "double", + "nullable": true } } }, - "ICampaignFilterResponseCountFilter": { + "IGraduationRule": { "required": [ - "dimension", - "responseCount", - "operator", + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IGraduationRuleAcceptedFreeTextRule" + }, + { + "$ref": "#/components/schemas/IGraduationRuleScoreThresholdRule" + }, + { + "$ref": "#/components/schemas/IGraduationRuleTaskAccuracyRule" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AcceptedFreeText": "#/components/schemas/IGraduationRuleAcceptedFreeTextRule", + "ScoreThreshold": "#/components/schemas/IGraduationRuleScoreThresholdRule", + "TaskAccuracy": "#/components/schemas/IGraduationRuleTaskAccuracyRule" + } + } + }, + "IGraduationRuleAcceptedFreeTextRule": { + "required": [ + "minAcceptedResponses", + "minAcceptedRatio", "_t" ], "properties": { "_t": { "enum": [ - "ResponseCountFilter" + "AcceptedFreeText" ], "type": "string" }, - "dimension": { - "type": "string" - }, - "responseCount": { + "minAcceptedResponses": { "type": "integer", "format": "uint32" }, - "operator": { - "$ref": "#/components/schemas/ComparisonOperator" + "minAcceptedRatio": { + "type": "number", + "format": "double" + }, + "demotionRatio": { + "type": "number", + "format": "double", + "nullable": true } } }, - "ICampaignFilterUserActionRestrictionFilter": { + "IGraduationRuleScoreThresholdRule": { "required": [ - "requiredActions", + "graduationScore", "_t" ], "properties": { "_t": { "enum": [ - "UserActionRestrictionFilter" + "ScoreThreshold" ], "type": "string" }, - "requiredActions": {} + "graduationScore": { + "type": "number", + "format": "double" + }, + "demotionScore": { + "type": "number", + "format": "double", + "nullable": true + }, + "minResponsesToGraduate": { + "type": "integer", + "format": "uint32", + "nullable": true + } } }, - "ICampaignFilterUserScoreFilter": { + "IGraduationRuleTaskAccuracyRule": { "required": [ - "dimension", - "lowerbound", - "upperbound", + "targetAccuracy", + "minTasks", "_t" ], "properties": { "_t": { "enum": [ - "UserScoreFilter" + "TaskAccuracy" ], "type": "string" }, - "dimension": { - "type": "string" - }, - "lowerbound": { + "targetAccuracy": { "type": "number", "format": "double" }, - "upperbound": { - "type": "number", - "format": "double" + "minTasks": { + "type": "integer", + "format": "int32" + }, + "maxTasks": { + "type": "integer", + "format": "int32", + "nullable": true } } }, - "ICampaignSelection": { + "IMetadata": { "required": [ "_t" ], "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/ICampaignSelectionAbTestSelection" + "$ref": "#/components/schemas/IMetadataClassificationMetadata" }, { - "$ref": "#/components/schemas/ICampaignSelectionAudienceSelection" + "$ref": "#/components/schemas/IMetadataCountMetadata" }, { - "$ref": "#/components/schemas/ICampaignSelectionCappedSelection" + "$ref": "#/components/schemas/IMetadataFileTypeMetadata" }, { - "$ref": "#/components/schemas/ICampaignSelectionConditionalValidationSelection" + "$ref": "#/components/schemas/IMetadataImageDimensionMetadata" }, { - "$ref": "#/components/schemas/ICampaignSelectionDemographicSelection" + "$ref": "#/components/schemas/IMetadataLocationMetadata" }, { - "$ref": "#/components/schemas/ICampaignSelectionEnforcingSelection" + "$ref": "#/components/schemas/IMetadataOriginalFilenameMetadata" }, { - "$ref": "#/components/schemas/ICampaignSelectionLabelingSelection" + "$ref": "#/components/schemas/IMetadataSourceUrlMetadata" }, { - "$ref": "#/components/schemas/ICampaignSelectionShufflingSelection" + "$ref": "#/components/schemas/IMetadataStreamsMetadata" }, { - "$ref": "#/components/schemas/ICampaignSelectionStaticSelection" + "$ref": "#/components/schemas/IMetadataTextMetadata" }, { - "$ref": "#/components/schemas/ICampaignSelectionValidationSelection" + "$ref": "#/components/schemas/IMetadataVideoDurationMetadata" } ], "discriminator": { "propertyName": "_t", "mapping": { - "AbTestSelection": "#/components/schemas/ICampaignSelectionAbTestSelection", - "AudienceSelection": "#/components/schemas/ICampaignSelectionAudienceSelection", - "CappedSelection": "#/components/schemas/ICampaignSelectionCappedSelection", - "ConditionalValidationSelection": "#/components/schemas/ICampaignSelectionConditionalValidationSelection", - "DemographicSelection": "#/components/schemas/ICampaignSelectionDemographicSelection", - "EnforcingSelection": "#/components/schemas/ICampaignSelectionEnforcingSelection", - "LabelingSelection": "#/components/schemas/ICampaignSelectionLabelingSelection", - "ShufflingSelection": "#/components/schemas/ICampaignSelectionShufflingSelection", - "StaticSelection": "#/components/schemas/ICampaignSelectionStaticSelection", - "ValidationSelection": "#/components/schemas/ICampaignSelectionValidationSelection" + "ClassificationMetadata": "#/components/schemas/IMetadataClassificationMetadata", + "CountMetadata": "#/components/schemas/IMetadataCountMetadata", + "FileTypeMetadata": "#/components/schemas/IMetadataFileTypeMetadata", + "ImageDimensionMetadata": "#/components/schemas/IMetadataImageDimensionMetadata", + "LocationMetadata": "#/components/schemas/IMetadataLocationMetadata", + "OriginalFilenameMetadata": "#/components/schemas/IMetadataOriginalFilenameMetadata", + "SourceUrlMetadataModel": "#/components/schemas/IMetadataSourceUrlMetadata", + "StreamsMetadata": "#/components/schemas/IMetadataStreamsMetadata", + "TextMetadata": "#/components/schemas/IMetadataTextMetadata", + "VideoDurationMetadata": "#/components/schemas/IMetadataVideoDurationMetadata" } } }, - "ICampaignSelectionAbTestSelection": { + "IMetadataClassificationMetadata": { "required": [ - "a", - "b", + "classification", "_t" ], "properties": { "_t": { "enum": [ - "AbTestSelection" + "ClassificationMetadata" ], "type": "string" }, - "a": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ICampaignSelection" - } - }, - "b": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ICampaignSelection" - } + "classification": { + "type": "string" } } }, - "ICampaignSelectionAudienceSelection": { + "IMetadataCountMetadata": { "required": [ - "audienceId", - "effort", - "retrievalMode", + "count", "_t" ], "properties": { "_t": { "enum": [ - "AudienceSelection" + "CountMetadata" ], "type": "string" }, - "audienceId": { - "type": "string" - }, - "effort": { + "count": { "type": "integer", "format": "int32" + } + } + }, + "IMetadataFileTypeMetadata": { + "required": [ + "fileType", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "FileTypeMetadata" + ], + "type": "string" }, - "retrievalMode": { - "$ref": "#/components/schemas/RetrievalMode" - }, - "maxIterations": { - "type": "integer", - "format": "int32", - "nullable": true + "fileType": { + "$ref": "#/components/schemas/FileType" } } }, - "ICampaignSelectionCappedSelection": { + "IMetadataImageDimensionMetadata": { "required": [ - "selections", - "maxRapids", "_t" ], "properties": { "_t": { "enum": [ - "CappedSelection" + "ImageDimensionMetadata" ], "type": "string" }, - "selections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ICampaignSelection" - } + "height": { + "type": "integer", + "format": "int32" }, - "maxRapids": { + "width": { "type": "integer", "format": "int32" } } }, - "ICampaignSelectionConditionalValidationSelection": { + "IMetadataInput": { "required": [ - "validationChances", - "dimensions", + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IMetadataInputTextMetadataInput" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "TextMetadataInput": "#/components/schemas/IMetadataInputTextMetadataInput" + } + } + }, + "IMetadataInputTextMetadataInput": { + "required": [ + "text", + "visibilities", "_t" ], "properties": { "_t": { "enum": [ - "ConditionalValidationSelection" + "TextMetadataInput" ], "type": "string" }, - "validationChances": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ValidationChance" - } + "text": { + "type": "string", + "nullable": true }, - "dimensions": { - "type": "array", - "items": { - "type": "string" - } + "visibilities": { + "$ref": "#/components/schemas/MetadataVisibilities" } } }, - "ICampaignSelectionDemographicSelection": { + "IMetadataLocationMetadata": { "required": [ - "keys", - "maxRapids", + "x", + "y", "_t" ], "properties": { "_t": { "enum": [ - "DemographicSelection" + "LocationMetadata" ], "type": "string" }, - "keys": { - "type": "array", - "items": { - "type": "string" - } - }, - "probability": { + "x": { "type": "number", - "format": "double", - "nullable": true + "format": "float" }, - "maxRapids": { - "type": "integer", - "format": "int32" + "y": { + "type": "number", + "format": "float" } } }, - "ICampaignSelectionEnforcingSelection": { + "IMetadataOriginalFilenameMetadata": { "required": [ - "selections", - "minSelections", - "minRapids", + "originalFilename", "_t" ], "properties": { "_t": { "enum": [ - "EnforcingSelection" + "OriginalFilenameMetadata" ], "type": "string" }, - "selections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ICampaignSelection" - } - }, - "minSelections": { - "type": "integer", - "format": "int32" - }, - "minRapids": { - "type": "integer", - "format": "int32" + "originalFilename": { + "type": "string" } } }, - "ICampaignSelectionLabelingSelection": { + "IMetadataSourceUrlMetadata": { "required": [ - "effortBudget", - "retrievalMode", + "url", "_t" ], "properties": { "_t": { "enum": [ - "LabelingSelection" + "SourceUrlMetadataModel" ], "type": "string" }, - "amount": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "effortBudget": { - "type": "integer", - "format": "int32" - }, - "retrievalMode": { - "$ref": "#/components/schemas/RetrievalMode" - }, - "maxIterations": { - "type": "integer", - "format": "int32", - "nullable": true + "url": { + "type": "string" } } }, - "ICampaignSelectionShufflingSelection": { + "IMetadataStreamsMetadata": { "required": [ - "selections", + "hasVideo", + "hasAudio", + "hasSubtitles", "_t" ], "properties": { "_t": { "enum": [ - "ShufflingSelection" + "StreamsMetadata" ], "type": "string" }, - "selections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ICampaignSelection" - } + "hasVideo": { + "type": "boolean" + }, + "hasAudio": { + "type": "boolean" + }, + "hasSubtitles": { + "type": "boolean" } } }, - "ICampaignSelectionStaticSelection": { + "IMetadataTextMetadata": { "required": [ - "rapidIds", + "text", "_t" ], "properties": { "_t": { "enum": [ - "StaticSelection" + "TextMetadata" ], "type": "string" }, - "rapidIds": { - "type": "array", - "items": { - "type": "string" - } + "text": { + "type": "string", + "nullable": true } } }, - "ICampaignSelectionValidationSelection": { + "IMetadataVideoDurationMetadata": { "required": [ - "validationSetId", + "duration", "_t" ], "properties": { "_t": { "enum": [ - "ValidationSelection" + "VideoDurationMetadata" ], "type": "string" }, - "validationSetId": { - "type": "string" + "duration": { + "type": "string", + "format": "date-time" + } + } + }, + "MetadataInputCollection": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/IMetadataInput" + } + }, + "MetadataModelCollection": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/IMetadata" + } + }, + "MetadataVisibilities": { + "type": "array", + "items": { + "enum": [ + "None", + "Users", + "Customers", + "Admins", + "Dashboard", + "All" + ], + "type": "string" + } + }, + "QueryAudienceJobsEndpoint_Output": { + "required": [ + "jobId", + "name", + "definitionId", + "audienceId", + "revisionNumber", + "pipelineId", + "state", + "createdAt" + ], + "type": "object", + "properties": { + "jobId": { + "type": "string", + "description": "The unique identifier of the job." }, - "amount": { - "type": "integer", - "format": "int32", - "nullable": true + "name": { + "type": "string", + "description": "The name of the job." }, - "effortBudget": { + "definitionId": { + "type": "string", + "description": "The identifier of the job definition." + }, + "audienceId": { + "type": "string", + "description": "The identifier of the audience the job belongs to." + }, + "revisionNumber": { "type": "integer", - "format": "int32", - "nullable": true + "description": "The revision number of the job definition.", + "format": "int32" + }, + "pipelineId": { + "type": "string", + "description": "The identifier of the pipeline executing the job." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/AudienceJobState" + } + ], + "description": "The current status of the job.", + "deprecated": true + }, + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/AudienceJobState" + } + ], + "description": "The current status of the job." + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the job was created.", + "format": "date-time" } } }, - "ICooldownDuration": { + "QueryAudienceJobsEndpoint_PagedResultOfOutput": { "required": [ - "_t" + "total", + "page", + "pageSize", + "items" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/ICooldownDurationFixedCooldownDuration" + "properties": { + "total": { + "type": "integer", + "format": "int64" }, - { - "$ref": "#/components/schemas/ICooldownDurationRandomCooldownDuration" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FixedCooldownDuration": "#/components/schemas/ICooldownDurationFixedCooldownDuration", - "RandomCooldownDuration": "#/components/schemas/ICooldownDurationRandomCooldownDuration" + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryAudienceJobsEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "ICooldownDurationFixedCooldownDuration": { + "QueryAudiencesEndpoint_Output": { "required": [ - "duration", - "_t" + "id", + "name", + "status", + "qualifiedUserCount", + "filters", + "createdAt", + "ownerMail", + "organizationId", + "isPublic", + "isDistilling", + "graduationRule" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FixedCooldownDuration" + "id": { + "type": "string", + "description": "The unique identifier of the audience." + }, + "name": { + "type": "string", + "description": "The name of the audience." + }, + "description": { + "type": "string", + "description": "The markdown-supported description of the audience.", + "nullable": true + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/AudienceStatus" + } ], - "type": "string" + "description": "The current status of the audience." }, - "duration": { + "qualifiedUserCount": { + "type": "integer", + "description": "The number of users that have qualified for this audience.", + "format": "int64" + }, + "filters": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAudienceFilter" + } + } + ], + "description": "The filters applied to this audience." + }, + "logo": { + "type": "string", + "description": "The URL of the audience logo, if any.", + "nullable": true + }, + "createdAt": { "type": "string", + "description": "The timestamp when the audience was created.", "format": "date-time" + }, + "ownerMail": { + "type": "string", + "description": "The email of the audience owner." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "isPublic": { + "type": "boolean", + "description": "Whether the audience is publicly visible." + }, + "isDistilling": { + "type": "boolean", + "description": "Whether the audience is currently distilling users." + }, + "graduationRule": { + "allOf": [ + { + "$ref": "#/components/schemas/IGraduationRule" + } + ], + "description": "The rule this audience uses to graduate users — a score-threshold rule or a\n task-accuracy rule." + }, + "randomAdmissionProbability": { + "type": "number", + "description": "The probability of admitting a random user to the audience.", + "format": "double", + "nullable": true + }, + "health": { + "type": "number", + "description": "The health score of the audience.", + "format": "double", + "nullable": true + }, + "graduated": { + "type": "integer", + "description": "The number of graduated users.", + "format": "int64" + }, + "dropped": { + "type": "integer", + "description": "The number of dropped users.", + "format": "int64" + } + } + }, + "QueryAudiencesEndpoint_PagedResultOfOutput": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int64" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryAudiencesEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "ICooldownDurationRandomCooldownDuration": { + "QueryExamplesForAudienceEndpoint_Output": { "required": [ - "minDuration", - "maxDuration", - "seedByUserId", - "_t" + "id", + "asset", + "payload", + "correctCount", + "incorrectCount" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "RandomCooldownDuration" + "id": { + "type": "string", + "description": "The unique identifier of the example." + }, + "rapidId": { + "type": "string", + "description": "The ID of the rapid associated with this example.", + "nullable": true + }, + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } ], - "type": "string" + "description": "The asset associated with this example." }, - "minDuration": { + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/IExamplePayload" + } + ], + "description": "The payload of the example." + }, + "correctCount": { + "type": "integer", + "description": "The number of correct responses.", + "format": "int32" + }, + "incorrectCount": { + "type": "integer", + "description": "The number of incorrect responses.", + "format": "int32" + }, + "truth": { + "allOf": [ + { + "$ref": "#/components/schemas/IExampleTruth" + } + ], + "description": "The truth value of the example." + }, + "context": { "type": "string", - "format": "date-time" + "description": "The context text for the example.", + "nullable": true }, - "maxDuration": { + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The context asset for the example." + }, + "explanation": { "type": "string", - "format": "date-time" + "description": "The explanation for the example.", + "nullable": true }, - "seedByUserId": { - "type": "boolean" + "randomCorrectProbability": { + "type": "number", + "description": "The probability of a random correct answer.", + "format": "double" + }, + "isCommonSense": { + "type": "boolean", + "description": "Whether this example is common sense.", + "nullable": true + }, + "sortIndex": { + "type": "integer", + "description": "The sort index that controls serving order.", + "format": "int32" + }, + "visibility": { + "allOf": [ + { + "$ref": "#/components/schemas/ExampleVisibility" + } + ], + "description": "The visibility of this example. Public examples are visible to all customers." } } }, - "IProgramAction": { + "QueryExamplesForAudienceEndpoint_PagedResultOfOutput": { "required": [ - "_t" + "total", + "page", + "pageSize", + "items" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IProgramActionCompleteAction" + "properties": { + "total": { + "type": "integer", + "format": "int64" }, - { - "$ref": "#/components/schemas/IProgramActionServeRapidAction" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "CompleteAction": "#/components/schemas/IProgramActionCompleteAction", - "ServeRapidAction": "#/components/schemas/IProgramActionServeRapidAction" + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryExamplesForAudienceEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "IProgramActionCompleteAction": { + "RecreateExternalAudiencesEndpoint_Input": { "required": [ - "_t" + "recreateAll" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "CompleteAction" - ], - "type": "string" + "recreateAll": { + "type": "boolean", + "description": "Whether to recreate all 3 external audiences or only the missing ones." } } }, - "IProgramActionServeRapidAction": { + "RetrievalMode": { + "enum": [ + "Random", + "Shuffled", + "Sequential" + ] + }, + "StartAudienceInactivitySyncEndpoint_Output": { "required": [ - "routingId", - "_t" + "syncId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ServeRapidAction" - ], - "type": "string" - }, - "routingId": { - "type": "string" - }, - "retrievalMode": { - "$ref": "#/components/schemas/RetrievalMode" + "syncId": { + "type": "string", + "description": "The id of the inactivity sync that was started or reused." } } }, - "IProgramNode": { + "StartAudienceStateRecalculationEndpoint_Output": { "required": [ - "_t" + "recalculationId" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IProgramNodeActionNode" - }, - { - "$ref": "#/components/schemas/IProgramNodeCasesNode" - }, - { - "$ref": "#/components/schemas/IProgramNodeWeightedSplitNode" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ActionNode": "#/components/schemas/IProgramNodeActionNode", - "CasesNode": "#/components/schemas/IProgramNodeCasesNode", - "WeightedSplitNode": "#/components/schemas/IProgramNodeWeightedSplitNode" + "properties": { + "recalculationId": { + "type": "string", + "description": "The id of the recalculation that was started or reused." } } }, - "IProgramNodeActionNode": { - "required": [ - "action", - "_t" - ], + "UpdateAudienceEndpoint_Input": { + "type": "object", "properties": { - "_t": { - "enum": [ - "ActionNode" + "name": { + "type": "string", + "description": "The new name to give to this audience." + }, + "description": { + "type": "string", + "description": "The new description for the audience. Supports markdown. Set to null to remove.", + "nullable": true + }, + "filters": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/IAudienceFilter" + } + } ], - "type": "string" + "description": "The new filters to apply to any orders created for this audience.\n A filter can be used to restrict the audience to a specific subset of users." }, - "action": { - "$ref": "#/components/schemas/IProgramAction" - } - } - }, - "IProgramNodeCasesNode": { - "required": [ - "cases", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CasesNode" + "logo": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ExistingAssetInput" + } ], - "type": "string" + "description": "The new logo image for the audience. Must be an existing image asset.\n Set to null to remove the logo.", + "nullable": true }, - "cases": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProgramCase" - } + "minGraduatedForDistillingBoost": { + "type": "integer", + "description": "Minimum graduated users before disabling distilling boost.\n When graduated count is below this, external distilling audience ID is added to campaign boosting.", + "format": "int32", + "nullable": true }, - "defaultNodeId": { - "type": "string", + "minDistillingForGlobalBoost": { + "type": "integer", + "description": "Minimum distilling users before disabling global boost.\n When distilling count is below this, GlobalBoostLevel is set above zero.", + "format": "int32", "nullable": true - } - } - }, - "IProgramNodeWeightedSplitNode": { - "required": [ - "branches", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "WeightedSplitNode" + }, + "graduationRule": { + "allOf": [ + { + "$ref": "#/components/schemas/IGraduationRule" + } ], - "type": "string" + "description": "Replaces how users graduate into this audience — either a score-threshold rule or a\n task-accuracy rule." }, - "branches": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WeightedBranch" - } - } - } - }, - "IProgramPredicate": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IProgramPredicateAccuracyPredicate" + "maxDistillingResponses": { + "type": "integer", + "description": "Maximum responses before user exits the distilling campaign.\n Set to null to disable this exit condition.", + "format": "uint32", + "nullable": true }, - { - "$ref": "#/components/schemas/IProgramPredicateAnsweredCountPredicate" + "dropMinResponses": { + "type": "integer", + "description": "Minimum responses before the drop score check applies.\n Users need at least this many responses before they can be kicked out for low score.\n Set to null to apply drop score check from the first response.", + "format": "uint32", + "nullable": true }, - { - "$ref": "#/components/schemas/IProgramPredicateConsecutiveCorrectPredicate" + "dropScore": { + "type": "number", + "description": "Score floor - users below this score exit the distilling campaign\n (only after completing DropMinResponses).\n Set to null to disable this exit condition.", + "format": "double", + "nullable": true }, - { - "$ref": "#/components/schemas/IProgramPredicateConsecutiveIncorrectPredicate" + "maxDistillingSessions": { + "type": "integer", + "description": "Maximum sessions (rapid retrievals) before user exits the distilling campaign.\n Set to a value to enable session-based exit condition.", + "format": "uint32", + "nullable": true }, - { - "$ref": "#/components/schemas/IProgramPredicateCorrectCountPredicate" + "inactivityDropDays": { + "type": "integer", + "description": "Number of days of inactivity before a distilling user is dropped.\n Set to null to disable this exit condition.", + "format": "uint32", + "nullable": true }, - { - "$ref": "#/components/schemas/IProgramPredicateTimeElapsedPredicate" + "minSubmissionRate": { + "type": "number", + "description": "Minimum submission rate (responses / sessions) before a user is dropped.\n Set to null to disable this exit condition.", + "format": "double", + "nullable": true }, - { - "$ref": "#/components/schemas/IProgramPredicateUserAttributePredicate" + "minSessionsForSubmissionRate": { + "type": "integer", + "description": "Minimum number of sessions before the submission rate check applies.\n Set to null to apply from the first session.", + "format": "uint32", + "nullable": true }, - { - "$ref": "#/components/schemas/IProgramPredicateUserScorePredicate" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "AccuracyPredicate": "#/components/schemas/IProgramPredicateAccuracyPredicate", - "AnsweredCountPredicate": "#/components/schemas/IProgramPredicateAnsweredCountPredicate", - "ConsecutiveCorrectPredicate": "#/components/schemas/IProgramPredicateConsecutiveCorrectPredicate", - "ConsecutiveIncorrectPredicate": "#/components/schemas/IProgramPredicateConsecutiveIncorrectPredicate", - "CorrectCountPredicate": "#/components/schemas/IProgramPredicateCorrectCountPredicate", - "TimeElapsedPredicate": "#/components/schemas/IProgramPredicateTimeElapsedPredicate", - "UserAttributePredicate": "#/components/schemas/IProgramPredicateUserAttributePredicate", - "UserScorePredicate": "#/components/schemas/IProgramPredicateUserScorePredicate" + "minSubmissionRateGraduated": { + "type": "number", + "description": "Minimum submission rate for graduated users. If null, MinSubmissionRate applies to graduated users.\n Set a lower value to be more lenient with graduated users.", + "format": "double", + "nullable": true + }, + "distillingRetrievalMode": { + "allOf": [ + { + "$ref": "#/components/schemas/RetrievalMode" + } + ], + "description": "The retrieval mode used by the distilling campaign to select rapids for users." } } }, - "IProgramPredicateAccuracyPredicate": { - "required": [ - "comparison", - "threshold", - "_t" - ], + "UpdateAudienceEndpoint_Output": { + "type": "object", "properties": { - "_t": { - "enum": [ - "AccuracyPredicate" - ], - "type": "string" - }, - "comparison": { - "$ref": "#/components/schemas/ProgramComparison" - }, - "threshold": { - "type": "number", - "format": "double" + "recalculationId": { + "type": "string", + "description": "The id of the audience state recalculation that was dispatched as a result of this update.\n Only populated when state-affecting parameters (e.g. graduation score, drop score) changed;\n null when the update only touched descriptive fields or boost configuration.", + "nullable": true }, - "minimumAnswered": { - "type": "integer", - "format": "int32" + "inactivitySyncId": { + "type": "string", + "description": "The id of the audience inactivity sync that was dispatched as a result of this update.\n Only populated when InactivityDropDays was changed to a non-null value; null otherwise.", + "nullable": true } } }, - "IProgramPredicateAnsweredCountPredicate": { - "required": [ - "comparison", - "value", - "_t" - ], + "UpdateAudienceExampleEndpoint_Input": { + "type": "object", "properties": { - "_t": { - "enum": [ - "AnsweredCountPredicate" + "truth": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IExampleTruth" + } ], - "type": "string" + "description": "The truth for the example.", + "nullable": true }, - "comparison": { - "$ref": "#/components/schemas/ProgramComparison" + "instructionText": { + "type": "string", + "description": "The instruction shown to the user — the criteria for a compare example, the target\n for a locate, line or scrub example, or the title for a classify or transcription\n example. The example's answer options are left unchanged." }, - "value": { + "explanation": { + "type": "string", + "description": "The optional explanation that will be shown to the user when answering wrong.", + "nullable": true + }, + "context": { + "type": "string", + "description": "An optional text context that will be shown to the user.", + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "An optional asset that will be used as context to show to the user.", + "nullable": true + }, + "randomCorrectProbability": { + "type": "number", + "description": "The probability that if the user answers at random that they'll be correct.", + "format": "double", + "nullable": true + }, + "isCommonSense": { + "type": "boolean", + "description": "Whether this example should be treated as commonsense validation.", + "nullable": true + }, + "sortIndex": { "type": "integer", + "description": "The sort index that controls the serving order of this example.", "format": "int32" + }, + "visibility": { + "allOf": [ + { + "$ref": "#/components/schemas/ExampleVisibility" + } + ], + "description": "Controls who can see this example. Public examples are visible to all customers.\n Private examples are only visible to the customer who created them and admins." } - } + }, + "description": "Input model for updating an audience example." }, - "IProgramPredicateConsecutiveCorrectPredicate": { - "required": [ - "comparison", - "value", - "_t" - ], + "UpdateBoostConfigEndpoint_Input": { + "type": "object", "properties": { - "_t": { - "enum": [ - "ConsecutiveCorrectPredicate" - ], - "type": "string" - }, - "comparison": { - "$ref": "#/components/schemas/ProgramComparison" + "minDistillingForGlobalBoost": { + "type": "integer", + "description": "Minimum number of distilling users required to activate global boost.", + "format": "int32", + "nullable": true }, - "value": { + "minGraduatedForDistillingBoost": { "type": "integer", - "format": "int32" + "description": "Minimum number of graduated users required to activate distilling boost.", + "format": "int32", + "nullable": true } } }, - "IProgramPredicateConsecutiveIncorrectPredicate": { - "required": [ - "comparison", - "value", - "_t" - ], + "UpdateBoostConfigEndpoint_Output": { + "type": "object", "properties": { - "_t": { - "enum": [ - "ConsecutiveIncorrectPredicate" - ], - "type": "string" - }, - "comparison": { - "$ref": "#/components/schemas/ProgramComparison" - }, - "value": { - "type": "integer", - "format": "int32" + "recalculationId": { + "type": "string", + "description": "The id of the audience state recalculation dispatched by this update.\n Boost-only updates do not trigger a recalculation, so this is typically null.", + "nullable": true } } }, - "IProgramPredicateCorrectCountPredicate": { + "AudienceBoost": { "required": [ - "comparison", - "value", - "_t" + "externalAudienceId", + "level" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "CorrectCountPredicate" - ], - "type": "string" - }, - "comparison": { - "$ref": "#/components/schemas/ProgramComparison" + "externalAudienceId": { + "type": "integer", + "format": "int32" }, - "value": { + "level": { "type": "integer", "format": "int32" } } }, - "IProgramPredicateTimeElapsedPredicate": { + "BoostingControlMode": { + "enum": [ + "Manual", + "Automatic" + ] + }, + "BoostingProfile": { "required": [ - "comparison", - "seconds", - "_t" + "globalBoostLevel", + "prospectBlacklist", + "distillingBoosts", + "labelingBoosts" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "TimeElapsedPredicate" - ], - "type": "string" + "globalBoostLevel": { + "type": "integer", + "format": "int32" }, - "comparison": { - "$ref": "#/components/schemas/ProgramComparison" + "minAutoAdjustLevel": { + "type": "integer", + "format": "int32", + "nullable": true }, - "seconds": { + "maxAutoAdjustLevel": { "type": "integer", - "format": "int32" - } - } - }, - "IProgramPredicateUserAttributePredicate": { - "required": [ - "attribute", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "UserAttributePredicate" + "format": "int32", + "nullable": true + }, + "languageBoosts": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } ], - "type": "string" + "deprecated": true }, - "attribute": { - "$ref": "#/components/schemas/UserAttribute" + "prospectBlacklist": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } }, - "values": { + "distillingBoosts": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/AudienceBoost" + } + }, + "labelingBoosts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AudienceBoost" } } } }, - "IProgramPredicateUserScorePredicate": { + "BoostMode": { + "enum": [ + "Automatic", + "Manual" + ] + }, + "BoostStatus": { + "enum": [ + "Active", + "Inactive", + "Partial", + "Unknown" + ] + }, + "CampaignStatus": { + "enum": [ + "Created", + "Preview", + "Active", + "Analysis", + "Paused", + "Completed", + "SpendLimited" + ] + }, + "ChangeBoostEndpoint_Input": { "required": [ - "comparison", - "threshold", - "_t" + "isManual" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "UserScorePredicate" - ], - "type": "string" + "isManual": { + "type": "boolean", + "description": "Whether the manual overwrite should be applied." }, - "comparison": { - "$ref": "#/components/schemas/ProgramComparison" + "isActive": { + "type": "boolean", + "description": "Whether the boost is active. Deprecated in favor of Level.", + "deprecated": true }, - "threshold": { - "type": "number", - "format": "double" + "level": { + "type": "integer", + "description": "The boost level. Takes precedence over IsActive when set.", + "format": "int32", + "nullable": true } } }, - "ProgramCase": { + "ComparisonOperator": { + "enum": [ + "Equal", + "NotEqual", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual" + ] + }, + "CreateOwnerTierOverrideEndpoint_Input": { "required": [ - "predicate", - "nodeId" + "organizationId" ], "type": "object", "properties": { - "predicate": { - "$ref": "#/components/schemas/IProgramPredicate" + "organizationId": { + "type": "string", + "description": "The id of the organization this override applies to." }, - "nodeId": { - "type": "string" + "priorityOverride": { + "type": "integer", + "description": "The priority matching owners' jobs are created with. Null for no priority override.", + "format": "int32", + "nullable": true + }, + "boostOverride": { + "type": "integer", + "description": "The global boost level matching owners' campaigns are created with (0-10). Null for none.", + "format": "int32", + "nullable": true } } }, - "ProgramComparison": { - "enum": [ - "GreaterThanOrEqual", - "GreaterThan", - "LessThanOrEqual", - "LessThan", - "Equal" - ] + "CreateOwnerTierOverrideEndpoint_Output": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the created override." + } + } }, - "QueryCampaignsEndpoint_Output": { + "CreateProgramCampaignEndpoint_Input": { "required": [ - "id", "name", - "status", "priority", - "hasBooster", - "boostLevel", - "boostingControlMode", - "ownerMail", - "organizationId", - "createdAt" + "rootNodeId", + "nodes", + "maxRapids", + "maxDurationSeconds" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the campaign." - }, "name": { "type": "string", "description": "The name of the campaign." }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/CampaignStatus" - } - ], - "description": "The current status of the campaign." - }, "priority": { "type": "integer", - "description": "The priority level of the campaign.", + "description": "The priority weight the campaign competes with for sessions.", "format": "int32" }, - "hasBooster": { - "type": "boolean", - "description": "Whether the campaign has a booster." - }, - "boostLevel": { - "type": "integer", - "description": "The campaign's effective boost level (0-10). 0 when no boost is active.\n Lets clients render and edit the level without unpacking the boosting profile.", - "format": "int32" + "rootNodeId": { + "type": "string", + "description": "The node the program's evaluation enters at." }, - "boostingControlMode": { + "nodes": { "allOf": [ { - "$ref": "#/components/schemas/BoostingControlMode" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/IProgramNode" + } } ], - "description": "How the campaign's boost is controlled — Manual (user-editable) or Automatic\n (managed by an owning service; boost edits are rejected by the API)." - }, - "requiresBooster": { - "type": "boolean", - "description": "Whether the campaign requires a booster.", - "deprecated": true - }, - "ownerMail": { - "type": "string", - "description": "The email of the campaign owner." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - }, - "createdAt": { - "type": "string", - "description": "The timestamp when the campaign was created.", - "format": "date-time" - } - } - }, - "QueryCampaignsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" + "description": "The program's decision graph, keyed by node id." }, - "pageSize": { + "maxRapids": { "type": "integer", + "description": "The session ends after this many counted responses.", "format": "int32" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryCampaignsEndpoint_Output" - } - }, - "totalPages": { + "maxDurationSeconds": { "type": "integer", + "description": "The session ends after this many seconds.", "format": "int32" } } }, - "QueryExternalAudiencesEndpoint_Output": { + "CreateProgramCampaignEndpoint_Output": { "required": [ - "id", - "name" + "campaignId" ], "type": "object", "properties": { - "id": { - "type": "integer", - "description": "The external audience identifier.", - "format": "int32" - }, - "name": { + "campaignId": { "type": "string", - "description": "The name of the external audience." - }, - "count": { - "type": "integer", - "description": "The number of users in the audience.", - "format": "int64", - "nullable": true + "description": "The id of the created campaign." } } }, - "QueryExternalAudiencesEndpoint_PagedResultOfOutput": { + "GetBoostInsightsEndpoint_AudienceOutput": { "required": [ - "total", - "page", - "pageSize", - "items" + "externalAudienceId", + "contributors" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { + "externalAudienceId": { "type": "integer", "format": "int32" }, - "items": { + "contributors": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryExternalAudiencesEndpoint_Output" + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_ContributorOutput" } - }, - "totalPages": { - "type": "integer", - "format": "int32" } } }, - "QueryOwnerTierOverridesEndpoint_Output": { + "GetBoostInsightsEndpoint_ContributorOutput": { "required": [ - "id", - "organizationId", - "ownerMail", - "createdAt" + "campaignId", + "campaignName" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The id of the override." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization the override applies to." - }, - "priorityOverride": { - "type": "integer", - "description": "The priority matching owners' jobs are created with, or null.", - "format": "int32", - "nullable": true - }, - "boostOverride": { - "type": "integer", - "description": "The global boost level matching owners' campaigns are created with, or null.", - "format": "int32", - "nullable": true - }, - "ownerMail": { - "type": "string", - "description": "The email of the admin who created the override." + "campaignId": { + "type": "string" }, - "createdAt": { - "type": "string", - "description": "When the override was created.", - "format": "date-time" + "campaignName": { + "type": "string" } } }, - "SetFastBidMultiplierEndpoint_Input": { + "GetBoostInsightsEndpoint_GlobalBoostOutput": { "required": [ - "multiplier" + "effectiveLevel", + "contributors" ], "type": "object", "properties": { - "multiplier": { - "type": "number", - "description": "The bid multiplier to apply. Must be in [0, 50].", - "format": "double" + "effectiveLevel": { + "type": "integer", + "format": "int32" + }, + "contributors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LevelContributorOutput" + } } } }, - "SetFastBidMultiplierEndpoint_Output": { + "GetBoostInsightsEndpoint_LanguageBoostOutput": { "required": [ - "externalCampaignId", - "appliedMultiplier" + "language", + "contributors" ], "type": "object", "properties": { - "externalCampaignId": { - "type": "integer", - "description": "The external campaign id reported by the downstream system.", - "format": "int32" + "language": { + "type": "string" }, - "appliedMultiplier": { - "type": "number", - "description": "The bid multiplier the downstream system reports as currently applied.", - "format": "double" + "contributors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_ContributorOutput" + } } } }, - "SetManualGlobalBoostLevelEndpoint_Input": { + "GetBoostInsightsEndpoint_LevelContributorOutput": { + "required": [ + "campaignId", + "campaignName", + "level" + ], "type": "object", "properties": { + "campaignId": { + "type": "string" + }, + "campaignName": { + "type": "string" + }, "level": { "type": "integer", - "description": "The global boost level. Null disables manual mode and returns to automatic.", - "format": "int32", - "nullable": true + "format": "int32" } } }, - "SimplifiedAudienceUserState": { - "enum": [ - "Distilling", - "Graduated", - "Dropped" - ] - }, - "StickyConfig": { + "GetBoostInsightsEndpoint_LeveledAudienceOutput": { + "required": [ + "externalAudienceId", + "effectiveLevel", + "contributors" + ], "type": "object", "properties": { - "isEnabled": { - "type": "boolean" - }, - "dimension": { - "type": "string" - }, - "bypassFilters": { - "type": "boolean" - }, - "bypassPrioritySelection": { - "type": "boolean" + "externalAudienceId": { + "type": "integer", + "format": "int32" }, - "blockOtherStickyCampaigns": { - "type": "boolean" + "effectiveLevel": { + "type": "integer", + "format": "int32" }, - "clearOnPause": { - "type": "boolean" + "contributors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LevelContributorOutput" + } } } }, - "UpdateCampaignEndpoint_Input": { + "GetBoostInsightsEndpoint_Output": { + "required": [ + "mode", + "manualOverrideLevel", + "globalBoost", + "prospectBlacklist", + "distillingBoosts", + "labelingBoosts" + ], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The new name for the campaign." + "mode": { + "allOf": [ + { + "$ref": "#/components/schemas/BoostMode" + } + ], + "description": "The current boost mode." }, - "priority": { + "manualOverrideLevel": { "type": "integer", - "description": "The new priority value for the campaign.", - "format": "int32" - }, - "requiresBooster": { - "type": "boolean", - "description": "Legacy on/off toggle for boosting. Translates server-side to BoostLevel = 3\n when true and BoostLevel = 0 (clear) when false. New clients should send\n BoostLevel directly; this field is kept for backwards compatibility.", - "deprecated": true + "description": "The manual override level, if manual mode is active.", + "format": "int32", + "nullable": true }, - "boostLevel": { - "type": "integer", - "description": "The campaign's boost level. Set 1-10 to boost (the audience service decides whether\n the boost manifests as global, distilling, or labeling based on the campaign's\n filters). Set 0 to clear any existing boost. Ignored when BoostingProfile is\n also set (explicit profile wins).", - "format": "int32" + "globalBoost": { + "allOf": [ + { + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_GlobalBoostOutput" + } + ], + "description": "Global boost insight with contributing campaigns." }, - "boostingProfile": { + "languageBoosts": { "allOf": [ { - "$ref": "#/components/schemas/BoostingProfile" + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LanguageBoostOutput" + }, + "nullable": true } ], - "description": "The boosting profile configuration. Takes precedence over BoostLevel and\n RequiresBooster when set. Prefer BoostLevel — it lets the server derive\n the right profile (including filtered-audience creation) from the campaign's filters." + "description": "Language-specific boost insights.", + "deprecated": true }, - "stickyConfig": { + "audienceBoosts": { "allOf": [ { - "$ref": "#/components/schemas/StickyConfig" + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_AudienceOutput" + }, + "nullable": true } ], - "description": "The sticky behavior configuration." + "description": "Audience boost insights.", + "deprecated": true }, - "filters": { + "prospectBlacklist": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/ICampaignFilter" + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_AudienceOutput" } } ], - "description": "The targeting filters for the campaign." + "description": "Prospect blacklist insights." }, - "selections": { + "distillingBoosts": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/ICampaignSelection" + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LeveledAudienceOutput" } } ], - "description": "The rapid selections for the campaign." + "description": "Distilling boost insights." }, - "featureFlags": { + "labelingBoosts": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/GetBoostInsightsEndpoint_LeveledAudienceOutput" } } ], - "description": "The feature flags for the campaign." + "description": "Labeling boost insights." } } }, - "UpdateOwnerTierOverrideEndpoint_Input": { + "GetBoostStatusEndpoint_Output": { "required": [ - "organizationId" + "status", + "mode", + "activeCampaigns", + "inactiveCampaigns", + "unknownCampaigns" ], "type": "object", "properties": { - "organizationId": { - "type": "string", - "description": "The id of the organization this override applies to." - }, - "priorityOverride": { - "type": "integer", - "description": "The priority matching owners' jobs are created with. Null for no priority override.", - "format": "int32", - "nullable": true + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/BoostStatus" + } + ], + "description": "The current boost status." }, - "boostOverride": { - "type": "integer", - "description": "The global boost level matching owners' campaigns are created with (0-10). Null for none.", - "format": "int32", - "nullable": true - } - } - }, - "UpdateStreamProgramEndpoint_Input": { - "required": [ - "rootNodeId", - "nodes", - "maxRapids", - "maxDurationSeconds" - ], - "type": "object", - "properties": { - "rootNodeId": { - "type": "string", - "description": "The node the program's evaluation enters at." + "mode": { + "allOf": [ + { + "$ref": "#/components/schemas/BoostMode" + } + ], + "description": "The current boost mode." }, - "nodes": { + "activeCampaigns": { "allOf": [ { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IProgramNode" + "type": "array", + "items": { + "type": "string" } } ], - "description": "The program's decision graph, keyed by node id." + "description": "The list of active campaign identifiers." }, - "maxRapids": { - "type": "integer", - "description": "The session ends after this many counted responses.", - "format": "int32" + "inactiveCampaigns": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The list of inactive campaign identifiers." }, - "maxDurationSeconds": { - "type": "integer", - "description": "The session ends after this many seconds.", - "format": "int32" + "unknownCampaigns": { + "allOf": [ + { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + } + ], + "description": "The list of unknown campaign identifiers." } } }, - "UserAttribute": { - "enum": [ - "Country", - "Language" - ] - }, - "ValidationChance": { + "GetCampaignByIdEndpoint_ICampaignDetails": { "required": [ - "userScoreThreshold", - "chance", - "rapidCount" + "_t" ], "type": "object", - "properties": { - "userScoreThreshold": { - "type": "number", - "format": "double" - }, - "chance": { - "type": "number", - "format": "double" - }, - "rapidCount": { - "type": "integer", - "format": "int32" + "oneOf": [ + { + "$ref": "#/components/schemas/GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_RoutedCampaignDetails" }, - "selections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ICampaignSelection" - }, - "nullable": true + { + "$ref": "#/components/schemas/GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_ProgramCampaignDetails" } - } - }, - "WeightedBranch": { - "required": [ - "weight", - "nodeId" ], - "type": "object", - "properties": { - "weight": { - "type": "integer", - "format": "int32" - }, - "nodeId": { - "type": "string" + "description": "A campaign's details, identified by a discriminator. Implementations describe the\n type-specific configuration: a routed campaign's selections or a program campaign's\n stream program.", + "discriminator": { + "propertyName": "_t", + "mapping": { + "RoutedCampaign": "#/components/schemas/GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_RoutedCampaignDetails", + "ProgramCampaign": "#/components/schemas/GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_ProgramCampaignDetails" } } }, - "CreateDatapointEndpoint_Input": { + "GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_ProgramCampaignDetails": { "required": [ - "asset" + "id", + "name", + "status", + "priority", + "boostingProfile", + "boostingControlMode", + "hasBooster", + "boostLevel", + "stickyConfig", + "filters", + "featureFlags", + "ownerMail", + "organizationId", + "createdAt", + "version", + "rootNodeId", + "nodes", + "maxRapids", + "maxDurationSeconds", + "_t" ], - "type": "object", "properties": { - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } + "_t": { + "enum": [ + "ProgramCampaign" ], - "description": "The asset within the datapoint." + "type": "string" }, - "context": { + "id": { "type": "string", - "description": "An additional context to show the users when solving the rapid.", - "nullable": true + "description": "The unique identifier of the campaign." }, - "contextAsset": { + "name": { + "type": "string", + "description": "The name of the campaign." + }, + "status": { "allOf": [ { - "$ref": "#/components/schemas/IAssetInput" + "$ref": "#/components/schemas/CampaignStatus" } ], - "description": "An optional asset context for the datapoint." + "description": "The current status of the campaign." }, - "sortIndex": { + "priority": { "type": "integer", - "description": "The sort index represents the order of the datapoint in the dataset.", - "format": "int64", - "nullable": true - }, - "group": { - "type": "string", - "description": "The group a datapoint belongs to.", - "nullable": true - }, - "transcription": { - "type": "string", - "description": "For audio or video assets, an optional transcription of the content.", - "nullable": true + "description": "The priority level of the campaign.", + "format": "int32" }, - "privateMetadata": { + "boostingProfile": { "allOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true + "$ref": "#/components/schemas/BoostingProfile" } ], - "description": "Private metadata for internal tracking. Not displayed to users." - } - }, - "description": "The body request for creating a new datapoint." - }, - "CreateDatapointEndpoint_Output": { - "required": [ - "datapointId" - ], - "type": "object", - "properties": { - "datapointId": { - "type": "string", - "description": "The id of the created datapoint." - } - } - }, - "CreateDatasetEndpoint_Input": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name to give to the new dataset." - } - }, - "description": "The input for the create dataset endpoint." - }, - "CreateDatasetEndpoint_Output": { - "required": [ - "datasetId" - ], - "type": "object", - "properties": { - "datasetId": { - "type": "string", - "description": "The id of the created dataset." - } - }, - "description": "The result when a dataset has been created." - }, - "CreateDatasetGroupEndpoint_Input": { - "required": [ - "group" - ], - "type": "object", - "properties": { - "group": { - "type": "string", - "description": "The name of the group." - }, - "context": { - "type": "string", - "description": "The optional text context for the group.", - "nullable": true + "description": "The boosting profile configuration." }, - "contextAsset": { + "boostingControlMode": { "allOf": [ { - "$ref": "#/components/schemas/IAssetInput" + "$ref": "#/components/schemas/BoostingControlMode" } ], - "description": "The optional asset context for the group." - } - } - }, - "DatapointState": { - "enum": [ - "Ready", - "Pending", - "Failed" - ] - }, - "GetDatapointEndpoint_Output": { - "required": [ - "id", - "datasetId", - "state", - "asset", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The id of the datapoint." + "description": "The boosting control mode." }, - "datasetId": { - "type": "string", - "description": "The id of the dataset this datapoint belongs to." + "hasBooster": { + "type": "boolean", + "description": "Whether the campaign has a booster." }, - "state": { + "boostLevel": { + "type": "integer", + "description": "The campaign's effective boost level (0-10). 0 when no boost is active.\n Lets clients render and edit the level without unpacking the boosting profile.", + "format": "int32" + }, + "requiresBooster": { + "type": "boolean", + "description": "Whether the campaign requires a booster.", + "deprecated": true + }, + "stickyConfig": { "allOf": [ { - "$ref": "#/components/schemas/DatapointState" + "$ref": "#/components/schemas/StickyConfig" } ], - "description": "The current state of the datapoint." + "description": "The sticky behavior configuration." }, - "asset": { + "filters": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "type": "array", + "items": { + "$ref": "#/components/schemas/ICampaignFilter" + } } ], - "description": "The asset that will be displayed to the users." - }, - "context": { - "type": "string", - "description": "Optional context text shown to annotators alongside the datapoint.", - "nullable": true + "description": "The targeting filters for this campaign." }, - "contextAsset": { + "featureFlags": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } } ], - "description": "Optional context media (reference image/audio/video) shown alongside the datapoint." + "description": "The feature flags configured for this campaign." }, - "sortIndex": { - "type": "integer", - "description": "An optional upload index used to force a certain order.", - "format": "int64", - "nullable": true + "ownerMail": { + "type": "string", + "description": "The email of the campaign owner." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the campaign." }, "createdAt": { "type": "string", - "description": "The timestamp when the datapoint was created.", + "description": "The timestamp when the campaign was created.", "format": "date-time" - } - } - }, - "GetDatasetByIdEndpoint_Output": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the dataset." - } - } - }, - "GetDatasetProgressEndpoint_Output": { - "required": [ - "total", - "ready", - "pending", - "failed" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of datapoints in the dataset.", - "format": "int32" - }, - "ready": { - "type": "integer", - "description": "The number of datapoints that have been uploaded successfully.", - "format": "int32" - }, - "pending": { - "type": "integer", - "description": "The number of datapoints that are still being processed.", - "format": "int32" - }, - "failed": { - "type": "integer", - "description": "The number of datapoints that failed to upload.", - "format": "int32" - } - } - }, - "GetFailedDatapointsEndpoint_Datapoint": { - "required": [ - "id", - "datasetId", - "sortIndex", - "asset", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "datasetId": { - "type": "string" }, - "sortIndex": { + "version": { "type": "integer", - "format": "int64", - "nullable": true - }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "description": "The program's current version, for optimistic concurrency on save.", + "format": "int32" }, - "createdAt": { + "rootNodeId": { "type": "string", - "format": "date-time" - } - } - }, - "GetFailedDatapointsEndpoint_Output": { - "required": [ - "datapoints" - ], - "type": "object", - "properties": { - "datapoints": { + "description": "The node the program's evaluation enters at." + }, + "nodes": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetFailedDatapointsEndpoint_Datapoint" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/IProgramNode" } } ], - "description": "The list of failed datapoints." + "description": "The program's decision graph, keyed by node id." + }, + "maxRapids": { + "type": "integer", + "description": "The session ends after this many counted responses.", + "format": "int32" + }, + "maxDurationSeconds": { + "type": "integer", + "description": "The session ends after this many seconds.", + "format": "int32" } - } + }, + "description": "A program campaign: its sessions stream their rapids, driven by a stream program." }, - "QueryDatapointsByDatasetIdEndpoint_Output": { + "GetCampaignByIdEndpoint_ICampaignDetailsGetCampaignByIdEndpoint_RoutedCampaignDetails": { "required": [ "id", - "datasetId", - "asset" + "name", + "status", + "priority", + "boostingProfile", + "boostingControlMode", + "hasBooster", + "boostLevel", + "stickyConfig", + "filters", + "selections", + "featureFlags", + "ownerMail", + "organizationId", + "createdAt", + "_t" ], - "type": "object", "properties": { + "_t": { + "enum": [ + "RoutedCampaign" + ], + "type": "string" + }, "id": { "type": "string", - "description": "The id of the datapoint." + "description": "The unique identifier of the campaign." }, - "datasetId": { + "name": { "type": "string", - "description": "The id of the dataset this datapoint belongs to." + "description": "The name of the campaign." }, - "asset": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/CampaignStatus" } ], - "description": "The asset that will be displayed to the users." + "description": "The current status of the campaign." }, - "context": { - "type": "string", - "description": "Optional context text shown to annotators alongside the datapoint.", - "nullable": true + "priority": { + "type": "integer", + "description": "The priority level of the campaign.", + "format": "int32" }, - "contextAsset": { + "boostingProfile": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/BoostingProfile" } ], - "description": "Optional context media (reference image/audio/video) shown alongside the datapoint." - } - } - }, - "QueryDatapointsByDatasetIdEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" + "description": "The boosting profile configuration." }, - "page": { - "type": "integer", - "format": "int32" + "boostingControlMode": { + "allOf": [ + { + "$ref": "#/components/schemas/BoostingControlMode" + } + ], + "description": "The boosting control mode." }, - "pageSize": { + "hasBooster": { + "type": "boolean", + "description": "Whether the campaign has a booster." + }, + "boostLevel": { "type": "integer", + "description": "The campaign's effective boost level (0-10). 0 when no boost is active.\n Lets clients render and edit the level without unpacking the boosting profile.", "format": "int32" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryDatapointsByDatasetIdEndpoint_Output" - } + "requiresBooster": { + "type": "boolean", + "description": "Whether the campaign requires a booster.", + "deprecated": true }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "ShortenContextEndpoint_Input": { - "required": [ - "items" - ], - "type": "object", - "properties": { - "items": { + "stickyConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/StickyConfig" + } + ], + "description": "The sticky behavior configuration." + }, + "filters": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/ShortenContextEndpoint_InputItem" + "$ref": "#/components/schemas/ICampaignFilter" } } ], - "description": "The context/question pairs to shorten." - } - }, - "description": "The input for the shorten-context endpoint." - }, - "ShortenContextEndpoint_InputItem": { - "required": [ - "context", - "question" - ], - "type": "object", - "properties": { - "context": { - "type": "string" + "description": "The targeting filters for this campaign." }, - "question": { - "type": "string" - } - } - }, - "ShortenContextEndpoint_Output": { - "required": [ - "items" - ], - "type": "object", - "properties": { - "items": { + "selections": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/ShortenContextEndpoint_OutputItem" + "$ref": "#/components/schemas/ICampaignSelection" } } ], - "description": "The shortened contexts." + "description": "The rapid selections for this campaign." + }, + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + } + ], + "description": "The feature flags configured for this campaign." + }, + "ownerMail": { + "type": "string", + "description": "The email of the campaign owner." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the campaign." + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the campaign was created.", + "format": "date-time" } }, - "description": "The shortened contexts, in the same order as the input items." + "description": "A routed campaign: its rapids are served from a fixed selection list." }, - "ShortenContextEndpoint_OutputItem": { + "GetCampaignCacheEndpoint_CampaignEntry": { "required": [ - "shortenedContext" + "id", + "name", + "status", + "priority", + "filterCount", + "selectionCount", + "userScoreDimensionCount", + "featureFlagCount", + "rateLimitCount", + "isPreviewEnabled", + "boostingControlMode" ], "type": "object", "properties": { - "shortenedContext": { + "id": { "type": "string" - } - } - }, - "UpdateDatasetNameEndpoint_Input": { - "required": [ - "name" - ], - "type": "object", - "properties": { + }, "name": { - "type": "string", - "description": "The new name of the dataset." - } - } - }, - "AudienceBoost2": { - "required": [ - "audienceId", - "level" - ], - "type": "object", - "properties": { - "audienceId": { "type": "string" }, - "level": { + "status": { + "$ref": "#/components/schemas/CampaignStatus" + }, + "priority": { "type": "integer", "format": "int32" - } - } - }, - "CreateFlowEndpoint_Input": { - "required": [ - "name", - "criteria" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the ranking flow." - }, - "criteria": { - "type": "string", - "description": "The ranking criteria used to compare items." - }, - "audienceId": { - "type": "string", - "description": "Optional audience ID. When provided, the flow will only be served to users in this audience.", - "nullable": true - }, - "validationSetId": { - "type": "string", - "description": "Optional ID of the validation set to use.", - "nullable": true }, - "startingElo": { + "filterCount": { "type": "integer", - "description": "Initial Elo rating for new items. Defaults to 1200.", - "format": "int32", - "nullable": true + "format": "int32" }, - "maxResponses": { + "selectionCount": { "type": "integer", - "description": "Maximum number of responses per comparison.", - "format": "int32", - "nullable": true + "format": "int32" }, - "serveResponses": { + "userScoreDimensionCount": { "type": "integer", - "description": "Number of accepted responses per rapid at which to stop serving. When set, must be less than or equal to MaxResponses. Null defaults to MaxResponses.", - "format": "int32", - "nullable": true - }, - "serveToResponseRatio": { - "type": "number", - "description": "Ratio of concurrent serves to max responses. When set, limits serving to avoid over-collection.", - "format": "double", - "nullable": true + "format": "int32" }, - "serveTimeoutSeconds": { + "featureFlagCount": { "type": "integer", - "description": "Time in seconds a user has to submit an answer after loading the task. When set, overrides the global default.", - "format": "int32", - "nullable": true + "format": "int32" }, - "minResponses": { + "rateLimitCount": { "type": "integer", - "description": "Minimum number of responses per comparison. Defaults to 20.", - "format": "int32", - "nullable": true + "format": "int32" }, - "responsesRequired": { + "isPreviewEnabled": { + "type": "boolean" + }, + "boostingControlMode": { + "$ref": "#/components/schemas/BoostingControlMode" + } + } + }, + "GetCampaignCacheEndpoint_Output": { + "required": [ + "count", + "campaigns" + ], + "type": "object", + "properties": { + "count": { "type": "integer", - "description": "Deprecated. Use MaxResponses instead.", - "format": "int32", - "nullable": true, - "deprecated": true + "description": "The total number of cached campaigns.", + "format": "int32" }, - "featureFlags": { + "campaigns": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - ], - "description": "Optional feature flags to enable for this flow." - }, - "targetResponseCount": { - "type": "integer", - "description": "Target average response count per completed item. Enables PID control when set.", - "format": "int32", - "nullable": true - }, - "pidProportionalGain": { - "type": "number", - "description": "PID proportional gain. Defaults to 0.", - "format": "double", - "nullable": true - }, - "pidIntegralGain": { - "type": "number", - "description": "PID integral gain. Defaults to 0.003.", - "format": "double", - "nullable": true - }, - "pidDerivativeGain": { - "type": "number", - "description": "PID derivative gain. Defaults to 0.", - "format": "double", - "nullable": true - }, - "pidOutputOffset": { - "type": "number", - "description": "Constant offset added to the PID output before clamping, shifting the controller's operating point. Defaults to 25.", - "format": "double", - "nullable": true - }, - "pidMinSessionsPerMinute": { - "type": "integer", - "description": "Minimum sessions per minute the PID can set. Defaults to 20.", - "format": "int32", - "nullable": true - }, - "pidMaxSessionsPerMinute": { - "type": "integer", - "description": "Maximum sessions per minute the PID can set. Defaults to 50.", - "format": "int32", - "nullable": true - }, - "pidBatchMode": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/PidBatchMode" + "$ref": "#/components/schemas/GetCampaignCacheEndpoint_CampaignEntry" + } } ], - "description": "How PID output maps to campaign rate. Total: direct rate. PerBatch: multiplied by active batch count. PerBatchTimeWeighted: multiplied by time-weighted batch count. Defaults to Total.", - "nullable": true - }, - "drainDurationSeconds": { - "type": "integer", - "description": "Duration in seconds for draining flow items. Defaults to 40.", - "format": "int32", - "nullable": true + "description": "The list of cached campaign summaries." } } }, - "CreateFlowEndpoint_Output": { + "GetFastBidMultiplierEndpoint_Output": { "required": [ - "flowId" + "externalCampaignId", + "bidMultiplierValue" ], "type": "object", "properties": { - "flowId": { - "type": "string", - "description": "The ID of the created ranking flow." + "externalCampaignId": { + "type": "integer", + "description": "The external campaign id reported by the downstream system.", + "format": "int32" + }, + "bidMultiplierValue": { + "type": "number", + "description": "The current bid multiplier reported for the campaign.", + "format": "double" } } }, - "CreateFlowItemEndpoint_Input": { + "GetOrganizationOwnerTierEndpoint_Output": { "required": [ - "datasetId" + "organizationId", + "priority", + "globalBoostLevel" ], "type": "object", "properties": { - "datasetId": { + "organizationId": { "type": "string", - "description": "The ID of the dataset to use for this flow item." + "description": "The id of the organization the tier applies to." }, - "context": { - "type": "string", - "description": "Optional context to provide additional ranking guidance.", - "nullable": true + "priority": { + "type": "integer", + "description": "The priority the organization's campaigns are created with.", + "format": "int32" }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "Optional asset context to provide additional ranking guidance." + "globalBoostLevel": { + "type": "integer", + "description": "The global boost level the organization's campaigns are created with.", + "format": "int32" }, - "timeToLiveInSeconds": { + "priorityOverride": { "type": "integer", - "description": "Optional time-to-live in seconds before the flow item expires. Must be between 45 seconds and 1 hour; defaults to 4 minutes when omitted.", + "description": "The priority from the matching override, or null when the default applies.", "format": "int32", "nullable": true }, - "drainDurationInSeconds": { + "boostOverride": { "type": "integer", - "description": "Optional drain duration in seconds. When set, rapids are paused this many seconds before TTL expiry to allow in-flight responses to complete.", - "format": "int32", - "nullable": true - } - } - }, - "CreateFlowItemEndpoint_Output": { - "required": [ - "flowItemId" - ], - "type": "object", - "properties": { - "flowItemId": { - "type": "string", - "description": "The ID of the created flow item." - } - } - }, - "FlowItemState": { - "enum": [ - "Pending", - "Running", - "Completed", - "Failed", - "Stopping", - "Stopped", - "Incomplete" - ] - }, - "FlowType": { - "enum": [ - "Ranking" - ] - }, - "GetCompletionTimeHistogramEndpoint_Output": { - "required": [ - "buckets" - ], - "type": "object", - "properties": { - "buckets": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetCompletionTimeHistogramEndpoint_Output_Bucket" - } - } - ], - "description": "The histogram buckets." + "description": "The boost level from the matching override, or null when the default applies.", + "format": "int32", + "nullable": true } } }, - "GetCompletionTimeHistogramEndpoint_Output_Bucket": { + "GetUserScoreCacheEndpoint_Output": { "required": [ - "lowerBound", - "upperBound", - "count" + "count", + "scores" ], "type": "object", "properties": { - "lowerBound": { - "type": "number", - "format": "double" - }, - "upperBound": { - "type": "number", - "format": "double" - }, "count": { "type": "integer", + "description": "The total number of cached user scores.", "format": "int32" + }, + "scores": { + "allOf": [ + { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + ], + "description": "The cached dimension-to-score mappings." } } }, - "GetFlowItemByIdEndpoint_Output": { + "ICampaignFilter": { "required": [ - "id", - "flowId", - "datasetId", - "state", - "createdAt" + "_t" ], "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the flow item." + "oneOf": [ + { + "$ref": "#/components/schemas/ICampaignFilterAndFilter" }, - "flowId": { - "type": "string", - "description": "The ID of the flow this item belongs to." + { + "$ref": "#/components/schemas/ICampaignFilterAudienceStateFilter" }, - "datasetId": { - "type": "string", - "description": "The ID of the dataset used by this flow item." + { + "$ref": "#/components/schemas/ICampaignFilterCampaignCooldownFilter" }, - "workflowId": { - "type": "string", - "description": "The ID of the workflow created for this flow item.", - "nullable": true + { + "$ref": "#/components/schemas/ICampaignFilterCampaignIdFilter" }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/FlowItemState" - } - ], - "description": "The current state of the flow item." + { + "$ref": "#/components/schemas/ICampaignFilterCampaignSessionCountFilter" }, - "context": { - "type": "string", - "description": "Optional context associated with this flow item.", - "nullable": true + { + "$ref": "#/components/schemas/ICampaignFilterCountryFilter" }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "Optional asset context associated with this flow item." + { + "$ref": "#/components/schemas/ICampaignFilterDemographicFilter" }, - "failureMessage": { - "type": "string", - "description": "The failure message if the flow item failed.", - "nullable": true + { + "$ref": "#/components/schemas/ICampaignFilterDeviceFilter" }, - "expiresAt": { - "type": "string", - "description": "The expiration timestamp of the flow item.", - "format": "date-time", - "nullable": true + { + "$ref": "#/components/schemas/ICampaignFilterDspFilter" }, - "createdAt": { - "type": "string", - "description": "The timestamp when the flow item was created.", - "format": "date-time" + { + "$ref": "#/components/schemas/ICampaignFilterLanguageFilter" }, - "startedAt": { - "type": "string", - "description": "The timestamp when the flow item started processing.", - "format": "date-time", - "nullable": true + { + "$ref": "#/components/schemas/ICampaignFilterNewUserFilter" }, - "completedAt": { - "type": "string", - "description": "The timestamp when the flow item completed.", - "format": "date-time", - "nullable": true + { + "$ref": "#/components/schemas/ICampaignFilterNotFilter" }, - "failedAt": { - "type": "string", - "description": "The timestamp when the flow item failed.", - "format": "date-time", - "nullable": true + { + "$ref": "#/components/schemas/ICampaignFilterOrFilter" + }, + { + "$ref": "#/components/schemas/ICampaignFilterResponseCountFilter" + }, + { + "$ref": "#/components/schemas/ICampaignFilterUserActionRestrictionFilter" + }, + { + "$ref": "#/components/schemas/ICampaignFilterUserScoreFilter" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AndFilter": "#/components/schemas/ICampaignFilterAndFilter", + "AudienceStateFilter": "#/components/schemas/ICampaignFilterAudienceStateFilter", + "CampaignCooldownFilter": "#/components/schemas/ICampaignFilterCampaignCooldownFilter", + "CampaignIdFilter": "#/components/schemas/ICampaignFilterCampaignIdFilter", + "CampaignSessionCountFilter": "#/components/schemas/ICampaignFilterCampaignSessionCountFilter", + "CountryFilter": "#/components/schemas/ICampaignFilterCountryFilter", + "DemographicFilter": "#/components/schemas/ICampaignFilterDemographicFilter", + "DeviceFilter": "#/components/schemas/ICampaignFilterDeviceFilter", + "DspFilter": "#/components/schemas/ICampaignFilterDspFilter", + "LanguageFilter": "#/components/schemas/ICampaignFilterLanguageFilter", + "NewUserFilter": "#/components/schemas/ICampaignFilterNewUserFilter", + "NotFilter": "#/components/schemas/ICampaignFilterNotFilter", + "OrFilter": "#/components/schemas/ICampaignFilterOrFilter", + "ResponseCountFilter": "#/components/schemas/ICampaignFilterResponseCountFilter", + "UserActionRestrictionFilter": "#/components/schemas/ICampaignFilterUserActionRestrictionFilter", + "UserScoreFilter": "#/components/schemas/ICampaignFilterUserScoreFilter" } } }, - "GetFlowItemCreationTimeseriesEndpoint_Output": { + "ICampaignFilterAndFilter": { "required": [ - "datapoints" + "filters", + "_t" ], - "type": "object", "properties": { - "datapoints": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetFlowItemCreationTimeseriesEndpoint_Output_DataPoint" - } - } + "_t": { + "enum": [ + "AndFilter" ], - "description": "The timeseries data points." + "type": "string" + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICampaignFilter" + } } } }, - "GetFlowItemCreationTimeseriesEndpoint_Output_DataPoint": { + "ICampaignFilterAudienceStateFilter": { "required": [ - "timestamp", - "count" + "audienceId", + "allowedStates", + "includeUnknownState", + "_t" ], - "type": "object", "properties": { - "timestamp": { - "type": "string", - "format": "date-time" + "_t": { + "enum": [ + "AudienceStateFilter" + ], + "type": "string" }, - "count": { - "type": "integer", - "format": "int64" + "audienceId": { + "type": "string" + }, + "allowedStates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SimplifiedAudienceUserState" + } + }, + "includeUnknownState": { + "type": "boolean" } } }, - "GetRankingFlowItemResultsEndpoint_Output": { + "ICampaignFilterCampaignCooldownFilter": { "required": [ - "datapoints", - "totalVotes" + "cooldown", + "_t" ], - "type": "object", "properties": { - "datapoints": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRankingFlowItemResultsEndpoint_Output_Datapoint" - } - } + "_t": { + "enum": [ + "CampaignCooldownFilter" ], - "description": "The ranked datapoints with their Elo scores." + "type": "string" }, - "totalVotes": { - "type": "integer", - "description": "The total number of votes across all datapoints.", - "format": "int64" + "cooldown": { + "$ref": "#/components/schemas/ICooldownDuration" } } }, - "GetRankingFlowItemResultsEndpoint_Output_Datapoint": { + "ICampaignFilterCampaignIdFilter": { "required": [ - "id", - "asset", - "elo" + "campaignIds", + "_t" ], - "type": "object", "properties": { - "id": { + "_t": { + "enum": [ + "CampaignIdFilter" + ], "type": "string" }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "elo": { - "type": "integer", - "format": "int32" + "campaignIds": { + "type": "array", + "items": { + "type": "string" + } } } }, - "GetRankingFlowItemVoteMatrixEndpoint_Output": { + "ICampaignFilterCampaignSessionCountFilter": { "required": [ - "index", - "columns", - "data" + "sessionCount", + "operator", + "_t" ], - "type": "object", "properties": { - "index": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } + "_t": { + "enum": [ + "CampaignSessionCountFilter" ], - "description": "Row labels of the vote matrix." + "type": "string" }, - "columns": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Column labels of the vote matrix." + "sessionCount": { + "type": "integer", + "format": "uint32" }, - "data": { - "allOf": [ - { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - } - ], - "description": "The vote counts as a two-dimensional matrix where Data[i][j] is the number of times row i was preferred over column j." + "operator": { + "$ref": "#/components/schemas/ComparisonOperator" } } }, - "GetResponseCountHistogramEndpoint_Output": { + "ICampaignFilterCountryFilter": { "required": [ - "buckets" + "countries", + "_t" ], - "type": "object", "properties": { - "buckets": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetResponseCountHistogramEndpoint_Output_Bucket" - } - } + "_t": { + "enum": [ + "CountryFilter" ], - "description": "The histogram buckets." + "type": "string" + }, + "countries": { + "type": "array", + "items": { + "type": "string" + } } } }, - "GetResponseCountHistogramEndpoint_Output_Bucket": { + "ICampaignFilterDemographicFilter": { "required": [ - "lowerBound", - "upperBound", - "count" + "identifier", + "values", + "_t" ], - "type": "object", "properties": { - "lowerBound": { - "type": "number", - "format": "double" + "_t": { + "enum": [ + "DemographicFilter" + ], + "type": "string" }, - "upperBound": { - "type": "number", - "format": "double" + "identifier": { + "type": "string" }, - "count": { - "type": "integer", - "format": "int32" + "values": { + "type": "array", + "items": { + "type": "string" + } } } }, - "GetResponseCountTimeseriesEndpoint_Output": { + "ICampaignFilterDeviceFilter": { "required": [ - "datapoints" + "deviceTypes", + "_t" ], - "type": "object", "properties": { - "datapoints": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetResponseCountTimeseriesEndpoint_Output_DataPoint" - } - } + "_t": { + "enum": [ + "DeviceFilter" ], - "description": "The timeseries data points." + "type": "string" + }, + "deviceTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceType" + } } } }, - "GetResponseCountTimeseriesEndpoint_Output_DataPoint": { + "ICampaignFilterDspFilter": { "required": [ - "timestamp", - "averageResponseCount" + "dspNames", + "_t" ], - "type": "object", "properties": { - "timestamp": { - "type": "string", - "format": "date-time" + "_t": { + "enum": [ + "DspFilter" + ], + "type": "string" }, - "averageResponseCount": { - "type": "number", - "format": "double" + "dspNames": { + "type": "array", + "items": { + "type": "string" + } } } }, - "IFlow": { + "ICampaignFilterLanguageFilter": { "required": [ + "languages", "_t" ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IFlowRankingFlow" + "properties": { + "_t": { + "enum": [ + "LanguageFilter" + ], + "type": "string" + }, + "languages": { + "type": "array", + "items": { + "type": "string" + } } + } + }, + "ICampaignFilterNewUserFilter": { + "required": [ + "_t" ], - "description": "A flow definition exposed over the API, identified by a discriminator.\n Implementations describe the flow's type-specific configuration.", - "discriminator": { - "propertyName": "_t", - "mapping": { - "RankingFlow": "#/components/schemas/IFlowRankingFlow" + "properties": { + "_t": { + "enum": [ + "NewUserFilter" + ], + "type": "string" } } }, - "IFlowRankingFlow": { + "ICampaignFilterNotFilter": { "required": [ - "id", - "name", - "campaignId", - "flowItemCount", - "targetResponseCount", - "pidProportionalGain", - "pidIntegralGain", - "pidDerivativeGain", - "pidOutputOffset", - "pidMinSessionsPerMinute", - "pidMaxSessionsPerMinute", - "pidBatchMode", - "serveTimeoutSeconds", - "drainDurationSeconds", - "serveToResponseRatio", - "criteria", - "startingElo", - "minResponses", - "maxResponses", - "serveResponses", - "featureFlags", - "ownerId", - "ownerMail", - "organizationId", - "createdAt", + "filter", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "NotFilter" + ], + "type": "string" + }, + "filter": { + "$ref": "#/components/schemas/ICampaignFilter" + } + } + }, + "ICampaignFilterOrFilter": { + "required": [ + "filters", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "OrFilter" + ], + "type": "string" + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICampaignFilter" + } + } + } + }, + "ICampaignFilterResponseCountFilter": { + "required": [ + "dimension", + "responseCount", + "operator", "_t" ], "properties": { "_t": { "enum": [ - "RankingFlow" + "ResponseCountFilter" ], "type": "string" }, - "id": { - "type": "string", - "description": "The unique identifier of the flow." - }, - "type": { - "allOf": [ - { - "$ref": "#/components/schemas/FlowType" - } - ], - "description": "The type of the flow. Use the _t discriminator instead.", - "deprecated": true - }, - "name": { - "type": "string", - "description": "The name of the flow." - }, - "campaignId": { - "type": "string", - "description": "The ID of the campaign associated with this flow." + "dimension": { + "type": "string" }, - "flowItemCount": { + "responseCount": { "type": "integer", - "description": "The total number of items that have been added to this flow. Incremented atomically on each item creation.", - "format": "int64" + "format": "uint32" }, - "targetResponseCount": { - "type": "integer", - "description": "Target average response count per completed item. Enables PID-based automatic rate control when set. Null disables PID.", - "format": "int32", - "nullable": true + "operator": { + "$ref": "#/components/schemas/ComparisonOperator" + } + } + }, + "ICampaignFilterUserActionRestrictionFilter": { + "required": [ + "requiredActions", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "UserActionRestrictionFilter" + ], + "type": "string" }, - "pidProportionalGain": { - "type": "number", - "description": "PID proportional gain. Controls how strongly the rate reacts to the current error between target and actual response counts.", - "format": "double" + "requiredActions": {} + } + }, + "ICampaignFilterUserScoreFilter": { + "required": [ + "dimension", + "lowerbound", + "upperbound", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "UserScoreFilter" + ], + "type": "string" }, - "pidIntegralGain": { - "type": "number", - "description": "PID integral gain. Eliminates steady-state error by accumulating error over time. Includes anti-windup clamping.", - "format": "double" + "dimension": { + "type": "string" }, - "pidDerivativeGain": { + "lowerbound": { "type": "number", - "description": "PID derivative gain. Provides damping by reacting to the rate of change of the error, helping prevent overshoot.", "format": "double" }, - "pidOutputOffset": { + "upperbound": { "type": "number", - "description": "Constant offset added to the PID output before clamping, shifting the controller's operating point so the P/I/D terms trim around a non-zero baseline.", "format": "double" + } + } + }, + "ICampaignSelection": { + "required": [ + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ICampaignSelectionAbTestSelection" }, - "pidMinSessionsPerMinute": { - "type": "integer", - "description": "Minimum sessions per minute the PID controller can set. Prevents the rate from dropping to zero.", - "format": "int32" - }, - "pidMaxSessionsPerMinute": { - "type": "integer", - "description": "Maximum sessions per minute the PID controller can set. Prevents the rate from exceeding infrastructure capacity.", - "format": "int32" - }, - "pidBatchMode": { - "allOf": [ - { - "$ref": "#/components/schemas/PidBatchMode" - } - ], - "description": "How the PID output maps to the campaign rate. Total: used directly. PerBatch: multiplied by active item count. PerBatchTimeWeighted: multiplied by time-weighted active item count based on remaining TTL." - }, - "serveTimeoutSeconds": { - "type": "integer", - "description": "Maximum time in seconds a user has to submit an answer after loading the task. Null uses the system-wide default.", - "format": "int32", - "nullable": true - }, - "drainDurationSeconds": { - "type": "integer", - "description": "Grace period in seconds after an item stops receiving new serves, allowing in-flight responses to complete.", - "format": "int32" - }, - "serveToResponseRatio": { - "type": "number", - "description": "Ratio of serves to responses used to calculate how many tasks to serve per expected response.", - "format": "double", - "nullable": true - }, - "globalBoostLevel": { - "type": "integer", - "description": "Priority multiplier for the flow's campaign. Higher values increase annotator compensation to attract more responses.", - "format": "int32", - "nullable": true, - "deprecated": true - }, - "audienceBoosts": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceBoost2" - }, - "nullable": true - } - ], - "description": "Audience-specific boost levels that override the global boost for targeted demographics.", - "deprecated": true - }, - "audienceId": { - "type": "string", - "description": "Optional audience ID. When provided, the flow will only serve items to users in this audience.", - "nullable": true, - "deprecated": true - }, - "criteria": { - "type": "string", - "description": "The comparison instruction shown to annotators during ranking tasks (e.g. \"Which image is sharper?\").", - "nullable": true - }, - "startingElo": { - "type": "integer", - "description": "The initial Elo rating assigned to new items entering the ranking. Standard default is 1200.", - "format": "int32" - }, - "kFactor": { - "type": "integer", - "description": "Elo K-factor controlling rating volatility. Higher values cause larger rating changes per comparison. Used as a direct multiplier on the Elo change formula.", - "format": "int32", - "deprecated": true - }, - "scalingFactor": { - "type": "integer", - "description": "Elo scaling factor that determines how rating differences translate to expected win probabilities. A difference equal to the scaling factor gives the higher-rated item approximately 90% expected win rate.", - "format": "int32", - "deprecated": true + { + "$ref": "#/components/schemas/ICampaignSelectionAudienceSelection" }, - "minResponses": { - "type": "integer", - "description": "Minimum number of responses a ranking item must receive before it is considered sufficiently evaluated.", - "format": "int32" + { + "$ref": "#/components/schemas/ICampaignSelectionCappedSelection" }, - "maxResponses": { - "type": "integer", - "description": "Maximum number of responses a ranking item can receive before being removed from active ranking. Null allows unlimited responses.", - "format": "int32", - "nullable": true + { + "$ref": "#/components/schemas/ICampaignSelectionConditionalValidationSelection" }, - "serveResponses": { - "type": "integer", - "description": "Number of accepted responses per rapid at which to stop serving. Null defaults to MaxResponses.", - "format": "int32", - "nullable": true + { + "$ref": "#/components/schemas/ICampaignSelectionDemographicSelection" }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "Key-value feature flags that enable specific behaviors for this flow (e.g. rapid_hints)." + { + "$ref": "#/components/schemas/ICampaignSelectionEnforcingSelection" }, - "ownerId": { - "type": "string", - "description": "The ID of the customer who owns the flow.", - "format": "uuid" + { + "$ref": "#/components/schemas/ICampaignSelectionLabelingSelection" }, - "ownerMail": { - "type": "string", - "description": "The email of the customer who owns the flow." + { + "$ref": "#/components/schemas/ICampaignSelectionShufflingSelection" }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." + { + "$ref": "#/components/schemas/ICampaignSelectionStaticSelection" }, - "createdAt": { - "type": "string", - "description": "The timestamp when the flow was created.", - "format": "date-time" + { + "$ref": "#/components/schemas/ICampaignSelectionValidationSelection" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AbTestSelection": "#/components/schemas/ICampaignSelectionAbTestSelection", + "AudienceSelection": "#/components/schemas/ICampaignSelectionAudienceSelection", + "CappedSelection": "#/components/schemas/ICampaignSelectionCappedSelection", + "ConditionalValidationSelection": "#/components/schemas/ICampaignSelectionConditionalValidationSelection", + "DemographicSelection": "#/components/schemas/ICampaignSelectionDemographicSelection", + "EnforcingSelection": "#/components/schemas/ICampaignSelectionEnforcingSelection", + "LabelingSelection": "#/components/schemas/ICampaignSelectionLabelingSelection", + "ShufflingSelection": "#/components/schemas/ICampaignSelectionShufflingSelection", + "StaticSelection": "#/components/schemas/ICampaignSelectionStaticSelection", + "ValidationSelection": "#/components/schemas/ICampaignSelectionValidationSelection" } } }, - "PidBatchMode": { - "enum": [ - "Total", - "PerBatch", - "PerBatchTimeWeighted" - ] - }, - "ProblemDetails": { - "type": "object", + "ICampaignSelectionAbTestSelection": { + "required": [ + "a", + "b", + "_t" + ], "properties": { - "type": { - "type": "string", - "nullable": true - }, - "title": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer", - "format": "int32", - "nullable": true + "_t": { + "enum": [ + "AbTestSelection" + ], + "type": "string" }, - "detail": { - "type": "string", - "nullable": true + "a": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICampaignSelection" + } }, - "instance": { - "type": "string", - "nullable": true + "b": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICampaignSelection" + } } } }, - "QueryFlowItemsEndpoint_Output": { + "ICampaignSelectionAudienceSelection": { "required": [ - "id", - "datasetId", - "state", - "createdAt" + "audienceId", + "effort", + "retrievalMode", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the flow item." - }, - "datasetId": { - "type": "string", - "description": "The ID of the dataset used by this flow item." - }, - "workflowId": { - "type": "string", - "description": "The ID of the workflow created for this flow item.", - "nullable": true - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/FlowItemState" - } - ], - "description": "The current state of the flow item." - }, - "context": { - "type": "string", - "description": "Optional context associated with this flow item.", - "nullable": true - }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } + "_t": { + "enum": [ + "AudienceSelection" ], - "description": "Optional asset context associated with this flow item." - }, - "failureMessage": { - "type": "string", - "description": "The failure message if the flow item failed.", - "nullable": true + "type": "string" }, - "createdAt": { - "type": "string", - "description": "The timestamp when the flow item was created.", - "format": "date-time" + "audienceId": { + "type": "string" }, - "startedAt": { - "type": "string", - "description": "The timestamp when the flow item started processing.", - "format": "date-time", - "nullable": true + "effort": { + "type": "integer", + "format": "int32" }, - "completedAt": { - "type": "string", - "description": "The timestamp when the flow item completed.", - "format": "date-time", - "nullable": true + "retrievalMode": { + "$ref": "#/components/schemas/RetrievalMode" }, - "failedAt": { - "type": "string", - "description": "The timestamp when the flow item failed.", - "format": "date-time", + "maxIterations": { + "type": "integer", + "format": "int32", "nullable": true } } }, - "QueryFlowItemsEndpoint_PagedResultOfOutput": { + "ICampaignSelectionCappedSelection": { "required": [ - "total", - "page", - "pageSize", - "items" + "selections", + "maxRapids", + "_t" ], - "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" + "_t": { + "enum": [ + "CappedSelection" + ], + "type": "string" }, - "items": { + "selections": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryFlowItemsEndpoint_Output" + "$ref": "#/components/schemas/ICampaignSelection" } }, - "totalPages": { + "maxRapids": { "type": "integer", "format": "int32" } } }, - "QueryFlowsEndpoint_Output": { + "ICampaignSelectionConditionalValidationSelection": { "required": [ - "id", - "name", - "type", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" + "validationChances", + "dimensions", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the flow." - }, - "name": { - "type": "string", - "description": "The name of the flow." - }, - "type": { - "allOf": [ - { - "$ref": "#/components/schemas/FlowType" - } + "_t": { + "enum": [ + "ConditionalValidationSelection" ], - "description": "The type of the flow." - }, - "ownerId": { - "type": "string", - "description": "The ID of the customer who owns the flow.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The email of the customer who owns the flow." + "type": "string" }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." + "validationChances": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValidationChance" + } }, - "createdAt": { - "type": "string", - "description": "The timestamp when the flow was created.", - "format": "date-time" + "dimensions": { + "type": "array", + "items": { + "type": "string" + } } } }, - "QueryFlowsEndpoint_PagedResultOfOutput": { + "ICampaignSelectionDemographicSelection": { "required": [ - "total", - "page", - "pageSize", - "items" + "keys", + "maxRapids", + "_t" ], - "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" + "_t": { + "enum": [ + "DemographicSelection" + ], + "type": "string" }, - "page": { - "type": "integer", - "format": "int32" + "keys": { + "type": "array", + "items": { + "type": "string" + } }, - "pageSize": { + "probability": { + "type": "number", + "format": "double", + "nullable": true + }, + "maxRapids": { "type": "integer", "format": "int32" + } + } + }, + "ICampaignSelectionEnforcingSelection": { + "required": [ + "selections", + "minSelections", + "minRapids", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "EnforcingSelection" + ], + "type": "string" }, - "items": { + "selections": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryFlowsEndpoint_Output" + "$ref": "#/components/schemas/ICampaignSelection" } }, - "totalPages": { + "minSelections": { + "type": "integer", + "format": "int32" + }, + "minRapids": { "type": "integer", "format": "int32" } } }, - "UpdateConfigEndpoint_Input": { - "type": "object", + "ICampaignSelectionLabelingSelection": { + "required": [ + "effortBudget", + "retrievalMode", + "_t" + ], "properties": { - "audienceId": { - "type": "string", - "description": "Optional audience ID. When provided, the flow will only serve items to users in this audience. Set to null to remove the audience restriction.", - "nullable": true - }, - "criteria": { - "type": "string", - "description": "The ranking criteria used to compare items." - }, - "startingElo": { - "type": "integer", - "description": "Initial Elo rating for new items.", - "format": "int32" + "_t": { + "enum": [ + "LabelingSelection" + ], + "type": "string" }, - "minResponses": { + "amount": { "type": "integer", - "description": "Minimum number of responses per comparison.", - "format": "int32" + "format": "int32", + "nullable": true }, - "maxResponses": { + "effortBudget": { "type": "integer", - "description": "Maximum number of responses per comparison.", "format": "int32" }, - "serveResponses": { - "type": "integer", - "description": "Number of accepted responses per rapid at which to stop serving. Set to null to remove. Must be less than or equal to MaxResponses when both are set.", - "format": "int32", - "nullable": true - }, - "serveToResponseRatio": { - "type": "number", - "description": "Ratio of concurrent serves to max responses. Set to null to remove the limit.", - "format": "double", - "nullable": true + "retrievalMode": { + "$ref": "#/components/schemas/RetrievalMode" }, - "serveTimeoutSeconds": { + "maxIterations": { "type": "integer", - "description": "Time in seconds a user has to submit an answer after loading the task. Set to null to use the global default.", "format": "int32", "nullable": true + } + } + }, + "ICampaignSelectionShufflingSelection": { + "required": [ + "selections", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "ShufflingSelection" + ], + "type": "string" }, - "responsesRequired": { - "type": "integer", - "description": "Deprecated. Use MaxResponses instead.", - "format": "int32", - "deprecated": true + "selections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICampaignSelection" + } + } + } + }, + "ICampaignSelectionStaticSelection": { + "required": [ + "rapidIds", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "StaticSelection" + ], + "type": "string" }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } + "rapidIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ICampaignSelectionValidationSelection": { + "required": [ + "validationSetId", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "ValidationSelection" ], - "description": "Feature flags to enable for this flow." + "type": "string" }, - "targetResponseCount": { + "validationSetId": { + "type": "string" + }, + "amount": { "type": "integer", - "description": "Target average response count per completed item. Set to null to disable PID control.", "format": "int32", "nullable": true }, - "pidProportionalGain": { - "type": "number", - "description": "PID proportional gain.", - "format": "double" - }, - "pidIntegralGain": { - "type": "number", - "description": "PID integral gain.", - "format": "double" - }, - "pidDerivativeGain": { - "type": "number", - "description": "PID derivative gain.", - "format": "double" - }, - "pidOutputOffset": { - "type": "number", - "description": "Constant offset added to the PID output before clamping, shifting the controller's operating point.", - "format": "double" - }, - "pidMinSessionsPerMinute": { - "type": "integer", - "description": "Minimum sessions per minute the PID can set.", - "format": "int32" - }, - "pidMaxSessionsPerMinute": { + "effortBudget": { "type": "integer", - "description": "Maximum sessions per minute the PID can set.", - "format": "int32" - }, - "pidBatchMode": { - "allOf": [ - { - "$ref": "#/components/schemas/PidBatchMode" - } - ], - "description": "How PID output maps to campaign rate. Total: direct rate. PerBatch: multiplied by active batch count. PerBatchTimeWeighted: multiplied by time-weighted batch count." + "format": "int32", + "nullable": true } } }, - "AcceptOrgInvitationEndpoint_Input": { + "ICooldownDuration": { "required": [ - "token" + "_t" ], "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ICooldownDurationFixedCooldownDuration" + }, + { + "$ref": "#/components/schemas/ICooldownDurationRandomCooldownDuration" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "FixedCooldownDuration": "#/components/schemas/ICooldownDurationFixedCooldownDuration", + "RandomCooldownDuration": "#/components/schemas/ICooldownDurationRandomCooldownDuration" + } + } + }, + "ICooldownDurationFixedCooldownDuration": { + "required": [ + "duration", + "_t" + ], "properties": { - "token": { + "_t": { + "enum": [ + "FixedCooldownDuration" + ], + "type": "string" + }, + "duration": { "type": "string", - "description": "The single-use invitation token." + "format": "date-time" } } }, - "AcceptOrgInvitationEndpoint_Output": { + "ICooldownDurationRandomCooldownDuration": { "required": [ - "organizationId", - "membershipId" + "minDuration", + "maxDuration", + "seedByUserId", + "_t" ], - "type": "object", "properties": { - "organizationId": { + "_t": { + "enum": [ + "RandomCooldownDuration" + ], + "type": "string" + }, + "minDuration": { "type": "string", - "description": "The organization the customer joined." + "format": "date-time" }, - "membershipId": { + "maxDuration": { "type": "string", - "description": "The id of the created membership." + "format": "date-time" + }, + "seedByUserId": { + "type": "boolean" } } }, - "AuthorizationRelations_Bidder": { - "enum": [ - "Admin", - "Editor", - "Viewer" - ], - "description": "Relations on the singleton `bidder` object that carries global RTB access. Grants are\ndirect here and, unlike Organization, are never folded in from platform staff." - }, - "AuthorizationRelations_ExternalApp": { - "enum": [ - "Admin", - "Viewer" - ], - "description": "Relations on an `external_app` object — one object per third-party app that federates\non the OIDC `groups` claim. The apps themselves are `ExternalAppId`. The ladder is hierarchical: `admin` folds into `viewer`.\nGrants are direct and, like `Bidder`, are never folded in from platform staff —\nholding platform admin must not confer administration of a separate system." - }, - "AuthorizationRelations_Platform": { - "enum": [ - "Admin", - "Viewer" + "IProgramAction": { + "required": [ + "_t" ], - "description": "Relations on the singleton `platform` object. The model is hierarchical: `admin`\nfolds into `viewer`." - }, - "AuthorizationScope": { - "enum": [ - "Platform", - "Bidder", - "ExternalApp" - ] - }, - "Capability": { - "enum": [ - "SkipContentCheck", - "PreheatBoost", - "ManagedImageFaucet", - "RequestFeatures" + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IProgramActionCompleteAction" + }, + { + "$ref": "#/components/schemas/IProgramActionServeRapidAction" + } ], - "description": "The named platform-wide capability entitlements a customer can be granted. Each maps to a\n`capability` object in the authorization graph; convert to its object id with\nstring CapabilityExtensions.ToObjectId(Capability capability). Kept as a typed enum so\ncapability grants read explicitly at call sites (and, later, on endpoint contracts) instead of\npassing raw id strings around." + "discriminator": { + "propertyName": "_t", + "mapping": { + "CompleteAction": "#/components/schemas/IProgramActionCompleteAction", + "ServeRapidAction": "#/components/schemas/IProgramActionServeRapidAction" + } + } }, - "ChangeOrgMemberRoleEndpoint_Input": { + "IProgramActionCompleteAction": { "required": [ - "role" + "_t" ], - "type": "object", "properties": { - "role": { - "allOf": [ - { - "$ref": "#/components/schemas/OrgRole" - } + "_t": { + "enum": [ + "CompleteAction" ], - "description": "The org-scoped role to assign to the member." + "type": "string" } } }, - "Client": { + "IProgramActionServeRapidAction": { "required": [ - "client_id", - "client_secret", - "client_id_issued_at", - "client_secret_expires_at", - "redirect_uris", - "grant_types", - "response_types", - "client_name", - "client_uri", - "logo_uri", - "scope", - "contacts", - "tos_uri", - "policy_uri", - "jwks_uri", - "jwks" + "routingId", + "_t" ], - "type": "object", "properties": { - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string", - "nullable": true - }, - "client_id_issued_at": { - "type": "integer", - "format": "int64", - "nullable": true - }, - "client_secret_expires_at": { - "type": "integer", - "format": "int64", - "nullable": true - }, - "redirect_uris": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - }, - "nullable": true - }, - "grant_types": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - }, - "nullable": true - }, - "response_types": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - }, - "nullable": true - }, - "client_name": { - "type": "string", - "nullable": true - }, - "client_uri": { - "type": "string", - "nullable": true - }, - "logo_uri": { - "type": "string", - "nullable": true - }, - "scope": { - "type": "string", - "description": "String containing a space-separated list of scope values\n that the client can use when requesting access tokens.", - "nullable": true - }, - "contacts": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } + "_t": { + "enum": [ + "ServeRapidAction" ], - "description": "Array of strings representing ways to contact people responsible for this client,\n typically email addresses." - }, - "tos_uri": { - "type": "string", - "nullable": true - }, - "policy_uri": { - "type": "string", - "nullable": true + "type": "string" }, - "jwks_uri": { - "type": "string", - "nullable": true + "routingId": { + "type": "string" }, - "jwks": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/JsonWebKeySet" - } - ], - "nullable": true + "retrievalMode": { + "$ref": "#/components/schemas/RetrievalMode" } - }, - "description": "The response containing the id and secret of a dynamically registered client.\n Additionally, it contains all registered metadata for the client." + } }, - "CreateBridgeTokenEndpoint_Output": { + "IProgramNode": { "required": [ - "readKey", - "writeKey" + "_t" ], "type": "object", - "properties": { - "readKey": { - "type": "string", - "description": "The read key used to retrieve the authentication result." + "oneOf": [ + { + "$ref": "#/components/schemas/IProgramNodeActionNode" }, - "writeKey": { - "type": "string", - "description": "The write key used to store the authentication result." + { + "$ref": "#/components/schemas/IProgramNodeCasesNode" + }, + { + "$ref": "#/components/schemas/IProgramNodeWeightedSplitNode" } - } - }, - "CreateClientEndpoint_Input": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "An optional display name for the client.", - "nullable": true + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "ActionNode": "#/components/schemas/IProgramNodeActionNode", + "CasesNode": "#/components/schemas/IProgramNodeCasesNode", + "WeightedSplitNode": "#/components/schemas/IProgramNodeWeightedSplitNode" } } }, - "CreateClientEndpoint_Output": { + "IProgramNodeActionNode": { "required": [ - "clientId", - "clientSecret" + "action", + "_t" ], - "type": "object", "properties": { - "clientId": { - "type": "string", - "description": "The id of the created client." + "_t": { + "enum": [ + "ActionNode" + ], + "type": "string" }, - "clientSecret": { - "type": "string", - "description": "The secret of the created client." + "action": { + "$ref": "#/components/schemas/IProgramAction" } } }, - "CreateOrganizationEndpoint_Input": { + "IProgramNodeCasesNode": { "required": [ - "name", - "slug" + "cases", + "_t" ], - "type": "object", "properties": { - "name": { - "type": "string", - "description": "The human-readable name of the organization." + "_t": { + "enum": [ + "CasesNode" + ], + "type": "string" }, - "slug": { - "type": "string", - "description": "A URL-safe unique identifier for the organization." + "cases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProgramCase" + } }, - "primaryDomain": { + "defaultNodeId": { "type": "string", - "description": "The primary email domain associated with the organization, if any.", "nullable": true } } }, - "CreateOrganizationEndpoint_Output": { + "IProgramNodeWeightedSplitNode": { "required": [ - "organizationId" + "branches", + "_t" ], - "type": "object", "properties": { - "organizationId": { - "type": "string", - "description": "The id of the created organization." + "_t": { + "enum": [ + "WeightedSplitNode" + ], + "type": "string" + }, + "branches": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WeightedBranch" + } } } }, - "DynamicClientRegistrationRequest": { + "IProgramPredicate": { + "required": [ + "_t" + ], "type": "object", - "properties": { - "redirect_uris": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "grant_types": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "oneOf": [ + { + "$ref": "#/components/schemas/IProgramPredicateAccuracyPredicate" }, - "response_types": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + { + "$ref": "#/components/schemas/IProgramPredicateAnsweredCountPredicate" }, - "client_id": { - "type": "string", - "nullable": true + { + "$ref": "#/components/schemas/IProgramPredicateConsecutiveCorrectPredicate" }, - "client_name": { - "type": "string", - "nullable": true + { + "$ref": "#/components/schemas/IProgramPredicateConsecutiveIncorrectPredicate" }, - "client_uri": { - "type": "string", - "nullable": true + { + "$ref": "#/components/schemas/IProgramPredicateCorrectCountPredicate" }, - "logo_uri": { - "type": "string", - "nullable": true + { + "$ref": "#/components/schemas/IProgramPredicateTimeElapsedPredicate" }, - "scope": { - "type": "string", - "description": "String containing a space-separated list of scope values\n that the client can use when requesting access tokens.", - "nullable": true + { + "$ref": "#/components/schemas/IProgramPredicateUserAttributePredicate" }, - "contacts": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } + { + "$ref": "#/components/schemas/IProgramPredicateUserScorePredicate" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AccuracyPredicate": "#/components/schemas/IProgramPredicateAccuracyPredicate", + "AnsweredCountPredicate": "#/components/schemas/IProgramPredicateAnsweredCountPredicate", + "ConsecutiveCorrectPredicate": "#/components/schemas/IProgramPredicateConsecutiveCorrectPredicate", + "ConsecutiveIncorrectPredicate": "#/components/schemas/IProgramPredicateConsecutiveIncorrectPredicate", + "CorrectCountPredicate": "#/components/schemas/IProgramPredicateCorrectCountPredicate", + "TimeElapsedPredicate": "#/components/schemas/IProgramPredicateTimeElapsedPredicate", + "UserAttributePredicate": "#/components/schemas/IProgramPredicateUserAttributePredicate", + "UserScorePredicate": "#/components/schemas/IProgramPredicateUserScorePredicate" + } + } + }, + "IProgramPredicateAccuracyPredicate": { + "required": [ + "comparison", + "threshold", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "AccuracyPredicate" ], - "description": "Array of strings representing ways to contact people responsible for this client,\n typically email addresses." - }, - "tos_uri": { - "type": "string", - "nullable": true + "type": "string" }, - "policy_uri": { - "type": "string", - "nullable": true + "comparison": { + "$ref": "#/components/schemas/ProgramComparison" }, - "jwks_uri": { - "type": "string", - "nullable": true + "threshold": { + "type": "number", + "format": "double" }, - "jwks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonWebKeySet" - } - ], - "description": "Client's JSON Web Key Set [RFC7517] document value, which contains the client's public keys." + "minimumAnswered": { + "type": "integer", + "format": "int32" } - }, - "description": "The request body for dynamic client registration." - }, - "ExternalAppId": { - "enum": [ - "ArgoCd", - "Grafana" - ], - "description": " The third-party applications that federate on our OIDC `groups` claim and can therefore\n be administered through a grant here. Each maps to an `external_app` object in the\n authorization graph.\n A closed enum rather than a free-form id on purpose: an arbitrary string would let a typo\nwrite a grant against an object nothing consumes, which looks like access was granted but\nsilently is not. Adding an app is a value here plus a tuple — no model change.This is the app itself; the relation vocabulary defined on these objects is\nAuthorizationRelations.ExternalApp. The Id suffix here keeps the two\ndistinguishable: a file with using static AuthorizationRelations imports that\nnested enum, and identical short names would make every bare mention ambiguous." + } }, - "GetBidderRelationMembersEndpoint_CursorPagedResultOfOutput": { + "IProgramPredicateAnsweredCountPredicate": { "required": [ - "items" + "comparison", + "value", + "_t" ], - "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBidderRelationMembersEndpoint_Output" - } + "_t": { + "enum": [ + "AnsweredCountPredicate" + ], + "type": "string" }, - "nextCursor": { - "type": "string", - "nullable": true + "comparison": { + "$ref": "#/components/schemas/ProgramComparison" + }, + "value": { + "type": "integer", + "format": "int32" } - }, - "description": "A page of results identified by an opaque cursor rather than an offset. Used where the\nunderlying store pages by continuation token and a total count is unavailable or expensive.\nstring? CursorPagedResult<T>.NextCursor is null on the last page." + } }, - "GetBidderRelationMembersEndpoint_Output": { + "IProgramPredicateConsecutiveCorrectPredicate": { "required": [ - "customer", - "email", - "organizationName", - "organizationId", - "scope", - "relation", - "grantedAt" + "comparison", + "value", + "_t" ], - "type": "object", "properties": { - "customer": { - "type": "string", - "description": "The customer holding the relation.", - "format": "uuid" + "_t": { + "enum": [ + "ConsecutiveCorrectPredicate" + ], + "type": "string" }, - "email": { - "type": "string", - "description": "The email address of the customer." + "comparison": { + "$ref": "#/components/schemas/ProgramComparison" }, - "organizationName": { - "type": "string", - "description": "The name of the customer's active organization." + "value": { + "type": "integer", + "format": "int32" + } + } + }, + "IProgramPredicateConsecutiveIncorrectPredicate": { + "required": [ + "comparison", + "value", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "ConsecutiveIncorrectPredicate" + ], + "type": "string" }, - "organizationId": { - "type": "string", - "description": "The identifier of the customer's active organization." + "comparison": { + "$ref": "#/components/schemas/ProgramComparison" }, - "scope": { - "allOf": [ - { - "$ref": "#/components/schemas/AuthorizationScope" - } + "value": { + "type": "integer", + "format": "int32" + } + } + }, + "IProgramPredicateCorrectCountPredicate": { + "required": [ + "comparison", + "value", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "CorrectCountPredicate" ], - "description": "The object the relation is on." + "type": "string" }, - "relation": { - "$ref": "#/components/schemas/AuthorizationRelations_Bidder" + "comparison": { + "$ref": "#/components/schemas/ProgramComparison" }, - "grantedAt": { - "type": "string", - "description": "When the grant was written.", - "format": "date-time" + "value": { + "type": "integer", + "format": "int32" } } }, - "GetCapabilityGranteesEndpoint_CursorPagedResultOfOutput": { + "IProgramPredicateTimeElapsedPredicate": { "required": [ - "items" + "comparison", + "seconds", + "_t" ], - "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetCapabilityGranteesEndpoint_Output" - } + "_t": { + "enum": [ + "TimeElapsedPredicate" + ], + "type": "string" }, - "nextCursor": { - "type": "string", - "nullable": true + "comparison": { + "$ref": "#/components/schemas/ProgramComparison" + }, + "seconds": { + "type": "integer", + "format": "int32" } - }, - "description": "A page of results identified by an opaque cursor rather than an offset. Used where the\nunderlying store pages by continuation token and a total count is unavailable or expensive.\nstring? CursorPagedResult<T>.NextCursor is null on the last page." + } }, - "GetCapabilityGranteesEndpoint_Output": { + "IProgramPredicateUserAttributePredicate": { "required": [ - "organizationId", - "organizationName", - "timestamp" + "attribute", + "_t" ], - "type": "object", "properties": { - "organizationId": { - "type": "string", - "description": "The organization that holds the capability." + "_t": { + "enum": [ + "UserAttributePredicate" + ], + "type": "string" }, - "organizationName": { - "type": "string", - "description": "The human-readable name of the organization." + "attribute": { + "$ref": "#/components/schemas/UserAttribute" }, - "timestamp": { - "type": "string", - "description": "When the grant was written.", - "format": "date-time" + "values": { + "type": "array", + "items": { + "type": "string" + } } } }, - "GetCustomerCapabilitiesEndpoint_Output": { + "IProgramPredicateUserScorePredicate": { "required": [ - "capabilities" + "comparison", + "threshold", + "_t" ], - "type": "object", "properties": { - "capabilities": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Capability" - } - } + "_t": { + "enum": [ + "UserScorePredicate" ], - "description": "Capabilities granted to the organization the customer is acting under." + "type": "string" + }, + "comparison": { + "$ref": "#/components/schemas/ProgramComparison" + }, + "threshold": { + "type": "number", + "format": "double" } } }, - "GetExternalAppRelationMembersEndpoint_CursorPagedResultOfOutput": { + "ProgramCase": { "required": [ - "items" + "predicate", + "nodeId" ], "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetExternalAppRelationMembersEndpoint_Output" - } + "predicate": { + "$ref": "#/components/schemas/IProgramPredicate" }, - "nextCursor": { - "type": "string", - "nullable": true + "nodeId": { + "type": "string" } - }, - "description": "A page of results identified by an opaque cursor rather than an offset. Used where the\nunderlying store pages by continuation token and a total count is unavailable or expensive.\nstring? CursorPagedResult<T>.NextCursor is null on the last page." + } }, - "GetExternalAppRelationMembersEndpoint_Output": { + "ProgramComparison": { + "enum": [ + "GreaterThanOrEqual", + "GreaterThan", + "LessThanOrEqual", + "LessThan", + "Equal" + ] + }, + "QueryCampaignsEndpoint_Output": { "required": [ - "customer", - "email", - "organizationName", + "id", + "name", + "status", + "priority", + "hasBooster", + "boostLevel", + "boostingControlMode", + "ownerMail", "organizationId", - "scope", - "app", - "relation", - "grantedAt" + "createdAt" ], "type": "object", "properties": { - "customer": { + "id": { "type": "string", - "description": "The customer holding the relation.", - "format": "uuid" + "description": "The unique identifier of the campaign." }, - "email": { + "name": { "type": "string", - "description": "The email address of the customer." + "description": "The name of the campaign." }, - "organizationName": { - "type": "string", - "description": "The name of the customer's active organization." + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/CampaignStatus" + } + ], + "description": "The current status of the campaign." }, - "organizationId": { - "type": "string", - "description": "The identifier of the customer's active organization." + "priority": { + "type": "integer", + "description": "The priority level of the campaign.", + "format": "int32" }, - "scope": { + "hasBooster": { + "type": "boolean", + "description": "Whether the campaign has a booster." + }, + "boostLevel": { + "type": "integer", + "description": "The campaign's effective boost level (0-10). 0 when no boost is active.\n Lets clients render and edit the level without unpacking the boosting profile.", + "format": "int32" + }, + "boostingControlMode": { "allOf": [ { - "$ref": "#/components/schemas/AuthorizationScope" + "$ref": "#/components/schemas/BoostingControlMode" } ], - "description": "The object the relation is on." + "description": "How the campaign's boost is controlled — Manual (user-editable) or Automatic\n (managed by an owning service; boost edits are rejected by the API)." }, - "app": { - "$ref": "#/components/schemas/ExternalAppId" + "requiresBooster": { + "type": "boolean", + "description": "Whether the campaign requires a booster.", + "deprecated": true }, - "relation": { - "$ref": "#/components/schemas/AuthorizationRelations_ExternalApp" + "ownerMail": { + "type": "string", + "description": "The email of the campaign owner." }, - "grantedAt": { + "organizationId": { "type": "string", - "description": "When the grant was written.", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the campaign was created.", "format": "date-time" } } }, - "GetOrganizationCapabilitiesEndpoint_Output": { + "QueryCampaignsEndpoint_PagedResultOfOutput": { "required": [ - "capabilities" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "capabilities": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Capability" - } - } - ], - "description": "The capabilities granted to the organization, held by all of its members." + "total": { + "type": "integer", + "format": "int64" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryCampaignsEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "GetOrganizationEndpoint_Output": { + "QueryExternalAudiencesEndpoint_Output": { "required": [ "id", - "name", - "slug", - "primaryDomain" + "name" ], "type": "object", "properties": { "id": { - "type": "string", - "description": "The id of the organization." - }, - "name": { - "type": "string", - "description": "The human-readable name of the organization." + "type": "integer", + "description": "The external audience identifier.", + "format": "int32" }, - "slug": { + "name": { "type": "string", - "description": "The URL-safe unique identifier of the organization." + "description": "The name of the external audience." }, - "primaryDomain": { - "type": "string", - "description": "The primary email domain associated with the organization, if any.", + "count": { + "type": "integer", + "description": "The number of users in the audience.", + "format": "int64", "nullable": true } } }, - "GetPlatformRelationMembersEndpoint_CursorPagedResultOfOutput": { + "QueryExternalAudiencesEndpoint_PagedResultOfOutput": { "required": [ + "total", + "page", + "pageSize", "items" ], "type": "object", "properties": { + "total": { + "type": "integer", + "format": "int64" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetPlatformRelationMembersEndpoint_Output" + "$ref": "#/components/schemas/QueryExternalAudiencesEndpoint_Output" } }, - "nextCursor": { - "type": "string", - "nullable": true + "totalPages": { + "type": "integer", + "format": "int32" } - }, - "description": "A page of results identified by an opaque cursor rather than an offset. Used where the\nunderlying store pages by continuation token and a total count is unavailable or expensive.\nstring? CursorPagedResult<T>.NextCursor is null on the last page." + } }, - "GetPlatformRelationMembersEndpoint_Output": { + "QueryOwnerTierOverridesEndpoint_Output": { "required": [ - "customer", - "email", - "organizationName", + "id", "organizationId", - "scope", - "relation", - "grantedAt" + "ownerMail", + "createdAt" ], "type": "object", "properties": { - "customer": { - "type": "string", - "description": "The customer holding the relation.", - "format": "uuid" - }, - "email": { - "type": "string", - "description": "The email address of the customer." - }, - "organizationName": { + "id": { "type": "string", - "description": "The name of the customer's active organization." + "description": "The id of the override." }, "organizationId": { "type": "string", - "description": "The identifier of the customer's active organization." + "description": "The id of the organization the override applies to." }, - "scope": { - "allOf": [ - { - "$ref": "#/components/schemas/AuthorizationScope" - } - ], - "description": "The object the relation is on." + "priorityOverride": { + "type": "integer", + "description": "The priority matching owners' jobs are created with, or null.", + "format": "int32", + "nullable": true }, - "relation": { - "$ref": "#/components/schemas/AuthorizationRelations_Platform" + "boostOverride": { + "type": "integer", + "description": "The global boost level matching owners' campaigns are created with, or null.", + "format": "int32", + "nullable": true }, - "grantedAt": { + "ownerMail": { "type": "string", - "description": "When the grant was written.", + "description": "The email of the admin who created the override." + }, + "createdAt": { + "type": "string", + "description": "When the override was created.", "format": "date-time" } } }, - "GoogleOneTapLoginEndpoint_Input": { + "SetFastBidMultiplierEndpoint_Input": { "required": [ - "idToken" + "multiplier" ], "type": "object", "properties": { - "idToken": { - "type": "string", - "description": "The id token received from the Google One Tap login." + "multiplier": { + "type": "number", + "description": "The bid multiplier to apply. Must be in [0, 50].", + "format": "double" } } }, - "GoogleOneTapLoginEndpoint_Output": { + "SetFastBidMultiplierEndpoint_Output": { "required": [ - "requiresEmailConfirmation" + "externalCampaignId", + "appliedMultiplier" ], "type": "object", "properties": { - "requiresEmailConfirmation": { - "type": "boolean", - "description": "Whether the account still requires email confirmation." + "externalCampaignId": { + "type": "integer", + "description": "The external campaign id reported by the downstream system.", + "format": "int32" }, - "email": { - "type": "string", - "description": "The email of the signed-in user, if available.", + "appliedMultiplier": { + "type": "number", + "description": "The bid multiplier the downstream system reports as currently applied.", + "format": "double" + } + } + }, + "SetManualGlobalBoostLevelEndpoint_Input": { + "type": "object", + "properties": { + "level": { + "type": "integer", + "description": "The global boost level. Null disables manual mode and returns to automatic.", + "format": "int32", "nullable": true } } }, - "GrantBidderRelationEndpoint_Input": { - "required": [ - "customer", - "relation" - ], + "SimplifiedAudienceUserState": { + "enum": [ + "Distilling", + "Graduated", + "Dropped" + ] + }, + "StickyConfig": { "type": "object", "properties": { - "customer": { - "type": "string", - "description": "The customer to grant the relation to.", - "format": "uuid" + "isEnabled": { + "type": "boolean" }, - "relation": { - "$ref": "#/components/schemas/AuthorizationRelations_Bidder" + "dimension": { + "type": "string" + }, + "bypassFilters": { + "type": "boolean" + }, + "bypassPrioritySelection": { + "type": "boolean" + }, + "blockOtherStickyCampaigns": { + "type": "boolean" + }, + "clearOnPause": { + "type": "boolean" } } }, - "GrantExternalAppRelationEndpoint_Input": { - "required": [ - "customer", - "app", - "relation" - ], + "UpdateCampaignEndpoint_Input": { "type": "object", "properties": { - "customer": { + "name": { "type": "string", - "description": "The customer to grant the relation to.", - "format": "uuid" + "description": "The new name for the campaign." }, - "app": { - "$ref": "#/components/schemas/ExternalAppId" + "priority": { + "type": "integer", + "description": "The new priority value for the campaign.", + "format": "int32" }, - "relation": { - "$ref": "#/components/schemas/AuthorizationRelations_ExternalApp" + "requiresBooster": { + "type": "boolean", + "description": "Legacy on/off toggle for boosting. Translates server-side to BoostLevel = 3\n when true and BoostLevel = 0 (clear) when false. New clients should send\n BoostLevel directly; this field is kept for backwards compatibility.", + "deprecated": true + }, + "boostLevel": { + "type": "integer", + "description": "The campaign's boost level. Set 1-10 to boost (the audience service decides whether\n the boost manifests as global, distilling, or labeling based on the campaign's\n filters). Set 0 to clear any existing boost. Ignored when BoostingProfile is\n also set (explicit profile wins).", + "format": "int32" + }, + "boostingProfile": { + "allOf": [ + { + "$ref": "#/components/schemas/BoostingProfile" + } + ], + "description": "The boosting profile configuration. Takes precedence over BoostLevel and\n RequiresBooster when set. Prefer BoostLevel — it lets the server derive\n the right profile (including filtered-audience creation) from the campaign's filters." + }, + "stickyConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/StickyConfig" + } + ], + "description": "The sticky behavior configuration." + }, + "filters": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICampaignFilter" + } + } + ], + "description": "The targeting filters for the campaign." + }, + "selections": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/ICampaignSelection" + } + } + ], + "description": "The rapid selections for the campaign." + }, + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + } + ], + "description": "The feature flags for the campaign." } } }, - "GrantPlatformRelationEndpoint_Input": { + "UpdateOwnerTierOverrideEndpoint_Input": { "required": [ - "customer", - "relation" + "organizationId" ], "type": "object", "properties": { - "customer": { + "organizationId": { "type": "string", - "description": "The customer to grant the relation to.", - "format": "uuid" + "description": "The id of the organization this override applies to." }, - "relation": { - "$ref": "#/components/schemas/AuthorizationRelations_Platform" + "priorityOverride": { + "type": "integer", + "description": "The priority matching owners' jobs are created with. Null for no priority override.", + "format": "int32", + "nullable": true + }, + "boostOverride": { + "type": "integer", + "description": "The global boost level matching owners' campaigns are created with (0-10). Null for none.", + "format": "int32", + "nullable": true } } }, - "InviteOrgMemberEndpoint_Input": { + "UpdateStreamProgramEndpoint_Input": { "required": [ - "email", - "role" + "rootNodeId", + "nodes", + "maxRapids", + "maxDurationSeconds" ], "type": "object", "properties": { - "email": { + "rootNodeId": { "type": "string", - "description": "The email address to invite." + "description": "The node the program's evaluation enters at." }, - "role": { + "nodes": { "allOf": [ { - "$ref": "#/components/schemas/OrgRole" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/IProgramNode" + } } ], - "description": "The org-scoped role the resulting membership will confer." - } - } - }, - "InviteOrgMemberEndpoint_Output": { - "required": [ - "invitationId", - "token", - "expiresAt" - ], - "type": "object", - "properties": { - "invitationId": { - "type": "string", - "description": "The id of the created invitation." + "description": "The program's decision graph, keyed by node id." }, - "token": { - "type": "string", - "description": "The single-use token used to accept the invitation." + "maxRapids": { + "type": "integer", + "description": "The session ends after this many counted responses.", + "format": "int32" }, - "expiresAt": { - "type": "string", - "description": "The instant after which the invitation can no longer be accepted.", - "format": "date-time" + "maxDurationSeconds": { + "type": "integer", + "description": "The session ends after this many seconds.", + "format": "int32" } } }, - "JsonWebKey": { + "UserAttribute": { + "enum": [ + "Country", + "Language" + ] + }, + "ValidationChance": { + "required": [ + "userScoreThreshold", + "chance", + "rapidCount" + ], "type": "object", "properties": { - "alg": { - "type": "string", - "nullable": true - }, - "crv": { - "type": "string", - "nullable": true - }, - "d": { - "type": "string", - "nullable": true - }, - "dp": { - "type": "string", - "nullable": true - }, - "dq": { - "type": "string", - "nullable": true - }, - "e": { - "type": "string", - "nullable": true - }, - "k": { - "type": "string", - "nullable": true - }, - "key_ops": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "kid": { - "type": "string", - "nullable": true + "userScoreThreshold": { + "type": "number", + "format": "double" }, - "kty": { - "type": "string", - "nullable": true + "chance": { + "type": "number", + "format": "double" }, - "n": { - "type": "string", - "nullable": true + "rapidCount": { + "type": "integer", + "format": "int32" }, - "oth": { + "selections": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ICampaignSelection" }, "nullable": true + } + } + }, + "WeightedBranch": { + "required": [ + "weight", + "nodeId" + ], + "type": "object", + "properties": { + "weight": { + "type": "integer", + "format": "int32" }, - "p": { - "type": "string", - "nullable": true - }, - "q": { - "type": "string", - "nullable": true - }, - "qi": { - "type": "string", - "nullable": true - }, - "use": { - "type": "string", - "nullable": true - }, - "x": { - "type": "string", - "nullable": true - }, - "x5c": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "nodeId": { + "type": "string" + } + } + }, + "CreateDatapointEndpoint_Input": { + "required": [ + "asset" + ], + "type": "object", + "properties": { + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "The asset within the datapoint." }, - "x5t": { + "context": { "type": "string", + "description": "An additional context to show the users when solving the rapid.", "nullable": true }, - "x5t#S256": { - "type": "string", - "nullable": true + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "An optional asset context for the datapoint." }, - "x5u": { - "type": "string", + "sortIndex": { + "type": "integer", + "description": "The sort index represents the order of the datapoint in the dataset.", + "format": "int64", "nullable": true }, - "y": { + "group": { "type": "string", + "description": "The group a datapoint belongs to.", "nullable": true }, - "pub": { + "transcription": { "type": "string", + "description": "For audio or video assets, an optional transcription of the content.", "nullable": true }, - "priv": { - "type": "string", - "nullable": true - } - } - }, - "JsonWebKeySet": { - "type": "object", - "properties": { - "keys": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonWebKey" - }, - "nullable": true - } - } - }, - "ListOrgInvitationsEndpoint_Output": { - "required": [ - "invitations" - ], - "type": "object", - "properties": { - "invitations": { + "privateMetadata": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/ListOrgInvitationsEndpoint_Output_Invitation" - } + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true } ], - "description": "The pending invitations of the organization." + "description": "Private metadata for internal tracking. Not displayed to users." + } + }, + "description": "The body request for creating a new datapoint." + }, + "CreateDatapointEndpoint_Output": { + "required": [ + "datapointId" + ], + "type": "object", + "properties": { + "datapointId": { + "type": "string", + "description": "The id of the created datapoint." } } }, - "ListOrgInvitationsEndpoint_Output_Invitation": { + "CreateDatasetEndpoint_Input": { "required": [ - "invitationId", - "email", - "role", - "expiresAt", - "createdAt" + "name" ], "type": "object", "properties": { - "invitationId": { - "type": "string" - }, - "email": { - "type": "string" - }, - "role": { - "$ref": "#/components/schemas/OrgRole" - }, - "expiresAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { + "name": { "type": "string", - "format": "date-time" + "description": "The name to give to the new dataset." } - } + }, + "description": "The input for the create dataset endpoint." }, - "ListOrgMembersEndpoint_Output": { + "CreateDatasetEndpoint_Output": { "required": [ - "members" + "datasetId" ], "type": "object", "properties": { - "members": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/ListOrgMembersEndpoint_Output_Member" - } - } - ], - "description": "The members of the organization." + "datasetId": { + "type": "string", + "description": "The id of the created dataset." } - } + }, + "description": "The result when a dataset has been created." }, - "ListOrgMembersEndpoint_Output_Member": { + "CreateDatasetGroupEndpoint_Input": { "required": [ - "customerId", - "email", - "role", - "status" + "group" ], "type": "object", "properties": { - "customerId": { + "group": { "type": "string", - "format": "uuid" + "description": "The name of the group." }, - "email": { + "context": { "type": "string", + "description": "The optional text context for the group.", "nullable": true }, - "role": { - "$ref": "#/components/schemas/OrgRole" - }, - "status": { - "$ref": "#/components/schemas/MembershipStatus" + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "The optional asset context for the group." } } }, - "MembershipStatus": { - "enum": [ - "Active", - "Suspended" - ] - }, - "OrgRole": { + "DatapointState": { "enum": [ - "Owner", - "Admin", - "Editor", - "Viewer" + "Ready", + "Pending", + "Failed" ] }, - "QueryAllOrganizationsEndpoint_Output": { + "GetDatapointEndpoint_Output": { "required": [ "id", - "name", - "slug", - "memberCount" + "datasetId", + "state", + "asset", + "createdAt" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The id of the organization." + "description": "The id of the datapoint." }, - "name": { + "datasetId": { "type": "string", - "description": "The human-readable name of the organization." + "description": "The id of the dataset this datapoint belongs to." }, - "slug": { + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/DatapointState" + } + ], + "description": "The current state of the datapoint." + }, + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The asset that will be displayed to the users." + }, + "context": { "type": "string", - "description": "The URL-safe unique identifier of the organization." + "description": "Optional context text shown to annotators alongside the datapoint.", + "nullable": true }, - "memberCount": { + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "Optional context media (reference image/audio/video) shown alongside the datapoint." + }, + "sortIndex": { "type": "integer", - "description": "The number of members the organization has.", - "format": "int32" + "description": "An optional upload index used to force a certain order.", + "format": "int64", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the datapoint was created.", + "format": "date-time" } } }, - "QueryAllOrganizationsEndpoint_PagedResultOfOutput": { + "GetDatasetByIdEndpoint_Output": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the dataset." + } + } + }, + "GetDatasetProgressEndpoint_Output": { "required": [ "total", - "page", - "pageSize", - "items" + "ready", + "pending", + "failed" ], "type": "object", "properties": { "total": { "type": "integer", - "format": "int64" + "description": "The total number of datapoints in the dataset.", + "format": "int32" }, - "page": { + "ready": { "type": "integer", + "description": "The number of datapoints that have been uploaded successfully.", "format": "int32" }, - "pageSize": { + "pending": { "type": "integer", + "description": "The number of datapoints that are still being processed.", "format": "int32" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryAllOrganizationsEndpoint_Output" - } - }, - "totalPages": { + "failed": { "type": "integer", + "description": "The number of datapoints that failed to upload.", "format": "int32" } } }, - "QueryClientsEndpoint_Output": { + "GetFailedDatapointsEndpoint_Datapoint": { "required": [ - "clientId", - "displayName", + "id", + "datasetId", + "sortIndex", + "asset", "createdAt" ], "type": "object", "properties": { - "clientId": { - "type": "string", - "description": "The id of the client.", - "nullable": true + "id": { + "type": "string" }, - "displayName": { - "type": "string", - "description": "The optional display name of the client.", + "datasetId": { + "type": "string" + }, + "sortIndex": { + "type": "integer", + "format": "int64", "nullable": true }, + "asset": { + "$ref": "#/components/schemas/IAsset" + }, "createdAt": { "type": "string", - "description": "The time at which the client was created.", - "format": "date-time", - "nullable": true + "format": "date-time" } } }, - "QueryClientsEndpoint_PagedResultOfOutput": { + "GetFailedDatapointsEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "items" + "datapoints" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryClientsEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" + "datapoints": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetFailedDatapointsEndpoint_Datapoint" + } + } + ], + "description": "The list of failed datapoints." } } }, - "QueryCustomersEndpoint_Output": { + "QueryDatapointsByDatasetIdEndpoint_Output": { "required": [ "id", - "email", - "organizationName", - "organizationId" + "datasetId", + "asset" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the customer.", - "format": "uuid" + "description": "The id of the datapoint." }, - "email": { + "datasetId": { "type": "string", - "description": "The email address of the customer.", - "nullable": true + "description": "The id of the dataset this datapoint belongs to." }, - "organizationName": { - "type": "string", - "description": "The name of the organization this customer belongs to, if any.", - "nullable": true + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The asset that will be displayed to the users." }, - "organizationId": { + "context": { "type": "string", - "description": "The identifier of the organization this customer belongs to, if any.", + "description": "Optional context text shown to annotators alongside the datapoint.", "nullable": true + }, + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "Optional context media (reference image/audio/video) shown alongside the datapoint." } } }, - "QueryCustomersEndpoint_PagedResultOfOutput": { + "QueryDatapointsByDatasetIdEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -50920,7 +47119,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryCustomersEndpoint_Output" + "$ref": "#/components/schemas/QueryDatapointsByDatasetIdEndpoint_Output" } }, "totalPages": { @@ -50929,532 +47128,543 @@ } } }, - "QueryOrganizationsEndpoint_Output": { + "ShortenContextEndpoint_Input": { "required": [ - "id", - "name", - "slug", - "role" + "items" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The id of the organization." - }, - "name": { - "type": "string", - "description": "The human-readable name of the organization." - }, - "slug": { - "type": "string", - "description": "The URL-safe unique identifier of the organization." - }, - "role": { + "items": { "allOf": [ { - "$ref": "#/components/schemas/OrgRole" + "type": "array", + "items": { + "$ref": "#/components/schemas/ShortenContextEndpoint_InputItem" + } } ], - "description": "The caller's role in the organization." + "description": "The context/question pairs to shorten." + } + }, + "description": "The input for the shorten-context endpoint." + }, + "ShortenContextEndpoint_InputItem": { + "required": [ + "context", + "question" + ], + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "question": { + "type": "string" } } }, - "QueryOrganizationsEndpoint_PagedResultOfOutput": { + "ShortenContextEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", "items" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryOrganizationsEndpoint_Output" - } + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShortenContextEndpoint_OutputItem" + } + } + ], + "description": "The shortened contexts." + } + }, + "description": "The shortened contexts, in the same order as the input items." + }, + "ShortenContextEndpoint_OutputItem": { + "required": [ + "shortenedContext" + ], + "type": "object", + "properties": { + "shortenedContext": { + "type": "string" + } + } + }, + "UpdateDatasetNameEndpoint_Input": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The new name of the dataset." + } + } + }, + "AudienceBoost2": { + "required": [ + "audienceId", + "level" + ], + "type": "object", + "properties": { + "audienceId": { + "type": "string" }, - "totalPages": { + "level": { "type": "integer", "format": "int32" } } }, - "ReadBridgeTokenEndpoint_KeysOutput": { + "CreateFlowEndpoint_Input": { "required": [ - "accessToken", - "expiresIn", - "refreshToken", - "idToken", - "tokenType", - "scope" + "name", + "criteria" ], "type": "object", "properties": { - "accessToken": { + "name": { "type": "string", - "description": "The issued access token.", + "description": "The name of the ranking flow." + }, + "criteria": { + "type": "string", + "description": "The ranking criteria used to compare items." + }, + "audienceId": { + "type": "string", + "description": "Optional audience ID. When provided, the flow will only be served to users in this audience.", + "nullable": true + }, + "validationSetId": { + "type": "string", + "description": "Optional ID of the validation set to use.", + "nullable": true + }, + "startingElo": { + "type": "integer", + "description": "Initial Elo rating for new items. Defaults to 1200.", + "format": "int32", + "nullable": true + }, + "maxResponses": { + "type": "integer", + "description": "Maximum number of responses per comparison.", + "format": "int32", + "nullable": true + }, + "serveResponses": { + "type": "integer", + "description": "Number of accepted responses per rapid at which to stop serving. When set, must be less than or equal to MaxResponses. Null defaults to MaxResponses.", + "format": "int32", + "nullable": true + }, + "serveToResponseRatio": { + "type": "number", + "description": "Ratio of concurrent serves to max responses. When set, limits serving to avoid over-collection.", + "format": "double", + "nullable": true + }, + "serveTimeoutSeconds": { + "type": "integer", + "description": "Time in seconds a user has to submit an answer after loading the task. When set, overrides the global default.", + "format": "int32", + "nullable": true + }, + "minResponses": { + "type": "integer", + "description": "Minimum number of responses per comparison. Defaults to 20.", + "format": "int32", + "nullable": true + }, + "responsesRequired": { + "type": "integer", + "description": "Deprecated. Use MaxResponses instead.", + "format": "int32", + "nullable": true, + "deprecated": true + }, + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "Optional feature flags to enable for this flow." + }, + "targetResponseCount": { + "type": "integer", + "description": "Target average response count per completed item. Enables PID control when set.", + "format": "int32", + "nullable": true + }, + "pidProportionalGain": { + "type": "number", + "description": "PID proportional gain. Defaults to 0.", + "format": "double", + "nullable": true + }, + "pidIntegralGain": { + "type": "number", + "description": "PID integral gain. Defaults to 0.003.", + "format": "double", "nullable": true }, - "expiresIn": { - "type": "integer", - "description": "The lifetime of the access token, in seconds.", - "format": "int32", + "pidDerivativeGain": { + "type": "number", + "description": "PID derivative gain. Defaults to 0.", + "format": "double", "nullable": true }, - "refreshToken": { - "type": "string", - "description": "The refresh token used to obtain new access tokens.", + "pidOutputOffset": { + "type": "number", + "description": "Constant offset added to the PID output before clamping, shifting the controller's operating point. Defaults to 25.", + "format": "double", "nullable": true }, - "idToken": { - "type": "string", - "description": "The OpenID Connect ID token.", + "pidMinSessionsPerMinute": { + "type": "integer", + "description": "Minimum sessions per minute the PID can set. Defaults to 20.", + "format": "int32", "nullable": true }, - "tokenType": { - "type": "string", - "description": "The type of the issued token.", + "pidMaxSessionsPerMinute": { + "type": "integer", + "description": "Maximum sessions per minute the PID can set. Defaults to 50.", + "format": "int32", "nullable": true }, - "scope": { + "pidBatchMode": { "type": "string", - "description": "The scopes granted to the issued token.", + "oneOf": [ + { + "$ref": "#/components/schemas/PidBatchMode" + } + ], + "description": "How PID output maps to campaign rate. Total: direct rate. PerBatch: multiplied by active batch count. PerBatchTimeWeighted: multiplied by time-weighted batch count. Defaults to Total.", + "nullable": true + }, + "drainDurationSeconds": { + "type": "integer", + "description": "Duration in seconds for draining flow items. Defaults to 40.", + "format": "int32", "nullable": true } } }, - "ReadBridgeTokenEndpoint_NotAvailableOutput": { - "required": [ - "message" - ], - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "A message indicating that the keys are not yet available." - } - } - }, - "RevokeBidderRelationEndpoint_Input": { + "CreateFlowEndpoint_Output": { "required": [ - "customer", - "relation" + "flowId" ], "type": "object", "properties": { - "customer": { + "flowId": { "type": "string", - "description": "The customer to revoke the relation from.", - "format": "uuid" - }, - "relation": { - "$ref": "#/components/schemas/AuthorizationRelations_Bidder" + "description": "The ID of the created ranking flow." } } }, - "RevokeExternalAppRelationEndpoint_Input": { + "CreateFlowItemEndpoint_Input": { "required": [ - "customer", - "app", - "relation" + "datasetId" ], "type": "object", "properties": { - "customer": { + "datasetId": { "type": "string", - "description": "The customer to revoke the relation from.", - "format": "uuid" - }, - "app": { - "$ref": "#/components/schemas/ExternalAppId" + "description": "The ID of the dataset to use for this flow item." }, - "relation": { - "$ref": "#/components/schemas/AuthorizationRelations_ExternalApp" - } - } - }, - "RevokePlatformRelationEndpoint_Input": { - "required": [ - "customer", - "relation" - ], - "type": "object", - "properties": { - "customer": { + "context": { "type": "string", - "description": "The customer to revoke the relation from.", - "format": "uuid" + "description": "Optional context to provide additional ranking guidance.", + "nullable": true }, - "relation": { - "$ref": "#/components/schemas/AuthorizationRelations_Platform" - } - } - }, - "SendSurveyEndpoint_Input": { - "required": [ - "fields" - ], - "type": "object", - "properties": { - "fields": { + "contextAsset": { "allOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/components/schemas/IAssetInput" } ], - "description": "The fields of the survey." - } - } - }, - "SetOrganizationSupportSlackChannelEndpoint_Input": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The support Slack channel URL to set, or null/empty to clear it.", + "description": "Optional asset context to provide additional ranking guidance." + }, + "timeToLiveInSeconds": { + "type": "integer", + "description": "Optional time-to-live in seconds before the flow item expires. Must be between 45 seconds and 1 hour; defaults to 4 minutes when omitted.", + "format": "int32", "nullable": true - } - } - }, - "SubscribeToNewsletterEndpoint_Input": { - "required": [ - "email", - "token" - ], - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "The email of the user to subscribe." }, - "token": { - "type": "string", - "description": "The recaptcha token used to verify the caller is not a bot." - } - } - }, - "SwitchActiveOrganizationEndpoint_Input": { - "required": [ - "organizationId" - ], - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "The id of the organization to activate." + "drainDurationInSeconds": { + "type": "integer", + "description": "Optional drain duration in seconds. When set, rapids are paused this many seconds before TTL expiry to allow in-flight responses to complete.", + "format": "int32", + "nullable": true } } }, - "UnsubscribeFromNewsletterEndpoint_Input": { + "CreateFlowItemEndpoint_Output": { "required": [ - "email", - "token" + "flowItemId" ], "type": "object", "properties": { - "email": { - "type": "string", - "description": "The email of the user to unsubscribe." - }, - "token": { + "flowItemId": { "type": "string", - "description": "The recaptcha token used to verify the caller is not a bot." + "description": "The ID of the created flow item." } } }, - "UpdateOrganizationEndpoint_Input": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The new human-readable name, if changing it." - }, - "slug": { - "type": "string", - "description": "The new URL-safe unique identifier, if changing it." - } - } + "FlowItemState": { + "enum": [ + "Pending", + "Running", + "Completed", + "Failed", + "Stopping", + "Stopped", + "Incomplete" + ] }, - "BenchmarkDemographicDimension": { + "FlowType": { "enum": [ - "AgeBucket", - "Gender", - "Occupation", - "Country", - "Language" + "Ranking" ] }, - "BoostLeaderboardEndpoint_Input": { + "GetCompletionTimeHistogramEndpoint_Output": { "required": [ - "participants", - "totalResponses" + "buckets" ], "type": "object", "properties": { - "participants": { + "buckets": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GetCompletionTimeHistogramEndpoint_Output_Bucket" } } ], - "description": "The participants of the given leaderboard that should be boosted." - }, - "totalResponses": { - "type": "integer", - "description": "The total responses to add, shared across all participants.", - "format": "int32" - }, - "seed": { - "type": "integer", - "description": "Optional seed for deterministic matchup selection. Use the same value across leaderboards\n of a benchmark to have them boosted on the same image pairs. Omit for random selection.", - "format": "int64", - "nullable": true + "description": "The histogram buckets." } } }, - "ConfidenceInterval": { + "GetCompletionTimeHistogramEndpoint_Output_Bucket": { "required": [ - "lowerOffset", - "upperOffset" + "lowerBound", + "upperBound", + "count" ], "type": "object", "properties": { - "lowerOffset": { + "lowerBound": { "type": "number", "format": "double" }, - "upperOffset": { + "upperBound": { "type": "number", "format": "double" + }, + "count": { + "type": "integer", + "format": "int32" } } }, - "CreateBenchmarkEndpoint_Input": { + "GetFlowItemByIdEndpoint_Output": { "required": [ - "name" + "id", + "flowId", + "datasetId", + "state", + "createdAt" ], "type": "object", "properties": { - "name": { + "id": { "type": "string", - "description": "The name of the benchmark." + "description": "The unique identifier of the flow item." }, - "description": { + "flowId": { "type": "string", - "description": "Optional plain-text credit for the people or sources behind the benchmark. Limited to\n 2000 characters. Leave unset for no description.", - "nullable": true + "description": "The ID of the flow this item belongs to." }, - "initialBoostLevel": { - "type": "integer", - "description": "Initial boost level applied to the campaign of every run created from this benchmark.\n Leave unset to fall back to DefaultInitialBoostLevel. Admins\n may set any value the validator allows (0-10); non-admins are restricted to\n 0..BenchmarkEntity.DefaultInitialBoostLevel — anything outside that range returns\n 403 Forbidden via IsAllowedToSetInitialBoostLevel.", - "format": "int32", - "nullable": true + "datasetId": { + "type": "string", + "description": "The ID of the dataset used by this flow item." }, - "scoreShift": { - "type": "number", - "description": "Additive offset applied to displayed scores on the overall scoreboard of this\n benchmark. Defaults to 0 when unset.", - "format": "double", + "workflowId": { + "type": "string", + "description": "The ID of the workflow created for this flow item.", "nullable": true }, - "scoreScale": { - "type": "number", - "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on the overall scoreboard of this benchmark. Defaults to 1.0 when\n unset; must be strictly positive.", - "format": "double", - "nullable": true - } - } - }, - "CreateBenchmarkEndpoint_Output": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The id of the created benchmark." - } - } - }, - "CreateBenchmarkParticipantEndpoint_Input": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/FlowItemState" + } + ], + "description": "The current state of the flow item." + }, + "context": { "type": "string", - "description": "The name of the participant." + "description": "Optional context associated with this flow item.", + "nullable": true }, - "family": { + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "Optional asset context associated with this flow item." + }, + "failureMessage": { "type": "string", - "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), if any.", + "description": "The failure message if the flow item failed.", "nullable": true }, - "lab": { + "expiresAt": { "type": "string", - "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"), if any.", + "description": "The expiration timestamp of the flow item.", + "format": "date-time", "nullable": true }, - "proprietaryName": { + "createdAt": { "type": "string", - "description": "The vendor-facing display name of the model, if any.", + "description": "The timestamp when the flow item was created.", + "format": "date-time" + }, + "startedAt": { + "type": "string", + "description": "The timestamp when the flow item started processing.", + "format": "date-time", "nullable": true }, - "licenseType": { + "completedAt": { "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ModelLicenseType" - } - ], - "description": "The license classification of the underlying model, if any.", + "description": "The timestamp when the flow item completed.", + "format": "date-time", "nullable": true }, - "logo": { + "failedAt": { + "type": "string", + "description": "The timestamp when the flow item failed.", + "format": "date-time", + "nullable": true + } + } + }, + "GetFlowItemCreationTimeseriesEndpoint_Output": { + "required": [ + "datapoints" + ], + "type": "object", + "properties": { + "datapoints": { "allOf": [ { - "$ref": "#/components/schemas/ExistingAssetInput" + "type": "array", + "items": { + "$ref": "#/components/schemas/GetFlowItemCreationTimeseriesEndpoint_Output_DataPoint" + } } ], - "description": "An optional logo image for the model. Must be an existing image asset." + "description": "The timeseries data points." } } }, - "CreateBenchmarkParticipantEndpoint_Output": { + "GetFlowItemCreationTimeseriesEndpoint_Output_DataPoint": { "required": [ - "participantId", - "datasetId" + "timestamp", + "count" ], "type": "object", "properties": { - "participantId": { + "timestamp": { "type": "string", - "description": "The id of the created participant." + "format": "date-time" }, - "datasetId": { - "type": "string", - "description": "The id of the participant's dataset." + "count": { + "type": "integer", + "format": "int64" } } }, - "CreateLeaderboardEndpoint_Input": { + "GetRankingFlowItemResultsEndpoint_Output": { "required": [ - "name", - "instruction", - "showPrompt" + "datapoints", + "totalVotes" ], "type": "object", "properties": { - "benchmarkId": { - "type": "string", - "description": "If the leaderboard should be added to a preexisting benchmark, the benchmark id.", - "nullable": true - }, - "benchmarkName": { - "type": "string", - "description": "When no BenchmarkId is provided, the name of the new benchmark to create.", - "nullable": true - }, - "benchmarkDescription": { - "type": "string", - "description": "Optional plain-text credit for the people or sources behind the benchmark, applied to\n the new benchmark created via BenchmarkName. Limited to 2000 characters.\n Ignored when an existing BenchmarkId is provided. Leave unset for no\n description.", - "nullable": true - }, - "name": { - "type": "string", - "description": "The name of the leaderboard." - }, - "instruction": { - "type": "string", - "description": "The instruction datapoints will be matched up against." - }, - "showPrompt": { - "type": "boolean", - "description": "Indicates if the prompt is shown on the rapids." - }, - "showPromptAsset": { - "type": "boolean", - "description": "Whether the prompt asset should be shown on the rapids." - }, - "responseBudget": { - "type": "integer", - "description": "Total amount of responses that get collected per run.", - "format": "int32", - "nullable": true + "datapoints": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetRankingFlowItemResultsEndpoint_Output_Datapoint" + } + } + ], + "description": "The ranked datapoints with their Elo scores." }, - "minResponses": { + "totalVotes": { "type": "integer", - "description": "The minimum amount of responses that need to be collected per comparison.", - "format": "int32", - "nullable": true - }, - "isInversed": { - "type": "boolean", - "description": "Whether the results should be inversed, selecting the worse model." + "description": "The total number of votes across all datapoints.", + "format": "int64" + } + } + }, + "GetRankingFlowItemResultsEndpoint_Output_Datapoint": { + "required": [ + "id", + "asset", + "elo" + ], + "type": "object", + "properties": { + "id": { + "type": "string" }, - "audienceId": { - "type": "string", - "description": "Optional audience id; defaults to the global audience when unset.", - "nullable": true + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "priority": { + "elo": { "type": "integer", - "description": "Optional priority override applied to every run's job. Admin-only.\n When unset, runs use the default leaderboard priority.", "format": "int32" - }, - "weight": { - "type": "number", - "description": "Multiplier applied to every match result of this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards. Defaults to 1.0 when\n unset; unbounded (negative and zero values are accepted).", - "format": "double" - }, - "scoreShift": { - "type": "number", - "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard. Defaults to 0 when unset.", - "format": "double" - }, - "scoreScale": { - "type": "number", - "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard. Defaults to 1.0 when\n unset; must be strictly positive.", - "format": "double" - }, - "isHidden": { - "type": "boolean", - "description": "Whether the leaderboard should be created hidden. Admin-only." - }, - "isExcludedFromOverall": { - "type": "boolean", - "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard.\n When set, the leaderboard becomes an owner-only private experiment: its results do not\n contribute to the overall and it is visible only to its owner and admins. Defaults to\n false when unset." - }, - "voteAggregation": { + } + } + }, + "GetRankingFlowItemVoteMatrixEndpoint_Output": { + "required": [ + "index", + "columns", + "data" + ], + "type": "object", + "properties": { + "index": { "allOf": [ { - "$ref": "#/components/schemas/VoteAggregation" + "type": "array", + "items": { + "type": "string" + } } ], - "description": "How individual votes on a matchup are aggregated into the stored result. AllVotes\n counts every vote as a matchup; MajorityVote collapses each matchup to a single\n win for the majority side (ties split 0.5/0.5). Defaults to AllVotes when unset." + "description": "Row labels of the vote matrix." }, - "includedTags": { + "columns": { "allOf": [ { "type": "array", @@ -51463,1779 +47673,1918 @@ } } ], - "description": "Prompt tag values to restrict the leaderboard's matchups to. Only prompts carrying at\n least one of these tags are used; an empty list means no restriction." + "description": "Column labels of the vote matrix." }, - "excludedTags": { + "data": { "allOf": [ { "type": "array", "items": { - "type": "string" + "type": "array", + "items": { + "type": "number", + "format": "double" + } } } ], - "description": "Prompt tag values the leaderboard never creates matchups for. Takes precedence over\n includedTags: a prompt carrying an excluded tag is skipped even when one of its\n other tags is included." - }, - "featureFlags": { + "description": "The vote counts as a two-dimensional matrix where Data[i][j] is the number of times row i was preferred over column j." + } + } + }, + "GetResponseCountHistogramEndpoint_Output": { + "required": [ + "buckets" + ], + "type": "object", + "properties": { + "buckets": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true + "$ref": "#/components/schemas/GetResponseCountHistogramEndpoint_Output_Bucket" + } } ], - "description": "Feature flags applied to every order created by this leaderboard." - }, - "skipInitialRun": { - "type": "boolean", - "description": "Set to true to skip the initial standings run. A newly added model is still\n compared against the whole existing field and boost runs still work — there is just no\n run collecting the first responses. On the benchmark's first leaderboard, participants\n that already have result images are submitted into the field so those paths have a field\n to work with; on a benchmark that already has a leaderboard they are in it already and\n are left untouched. Defaults to false, which queues the run as before." + "description": "The histogram buckets." } } }, - "CreateLeaderboardEndpoint_Output": { + "GetResponseCountHistogramEndpoint_Output_Bucket": { "required": [ - "id", - "benchmarkId", - "showPrompt", - "showPromptAsset", - "responseBudget", - "minResponses", - "isInversed", - "voteAggregation" + "lowerBound", + "upperBound", + "count" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The id of the created leaderboard." - }, - "benchmarkId": { - "type": "string", - "description": "The id of the benchmark the leaderboard belongs to." - }, - "showPrompt": { - "type": "boolean", - "description": "Whether the prompt is shown on the rapids." - }, - "showPromptAsset": { - "type": "boolean", - "description": "Whether the prompt asset is shown on the rapids." + "lowerBound": { + "type": "number", + "format": "double" }, - "responseBudget": { - "type": "integer", - "description": "The response budget per run.", - "format": "int32" + "upperBound": { + "type": "number", + "format": "double" }, - "minResponses": { + "count": { "type": "integer", - "description": "The minimum responses per comparison.", "format": "int32" - }, - "isInversed": { - "type": "boolean", - "description": "Whether the leaderboard results are inversed." - }, - "voteAggregation": { - "allOf": [ - { - "$ref": "#/components/schemas/VoteAggregation" - } - ], - "description": "How individual votes on a matchup are aggregated into the stored result." } } }, - "CreateLeaderboardParticipantEndpoint_Input": { + "GetResponseCountTimeseriesEndpoint_Output": { "required": [ - "name" + "datapoints" ], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the participant." + "datapoints": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetResponseCountTimeseriesEndpoint_Output_DataPoint" + } + } + ], + "description": "The timeseries data points." } } }, - "CreateLeaderboardParticipantEndpoint_Output": { + "GetResponseCountTimeseriesEndpoint_Output_DataPoint": { "required": [ - "participantId", - "datasetId" + "timestamp", + "averageResponseCount" ], "type": "object", "properties": { - "participantId": { + "timestamp": { "type": "string", - "description": "The id of the created participant." + "format": "date-time" }, - "datasetId": { - "type": "string", - "description": "The id of the participant's dataset." + "averageResponseCount": { + "type": "number", + "format": "double" } } }, - "CreatePromptEmbeddingMapEndpoint_Output": { + "IFlow": { "required": [ - "id" + "_t" ], "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The id of the queued prompt embedding map." + "oneOf": [ + { + "$ref": "#/components/schemas/IFlowRankingFlow" + } + ], + "description": "A flow definition exposed over the API, identified by a discriminator.\n Implementations describe the flow's type-specific configuration.", + "discriminator": { + "propertyName": "_t", + "mapping": { + "RankingFlow": "#/components/schemas/IFlowRankingFlow" } } }, - "CreatePromptForBenchmarkEndpoint_Input": { + "IFlowRankingFlow": { "required": [ - "identifier" + "id", + "name", + "campaignId", + "flowItemCount", + "targetResponseCount", + "pidProportionalGain", + "pidIntegralGain", + "pidDerivativeGain", + "pidOutputOffset", + "pidMinSessionsPerMinute", + "pidMaxSessionsPerMinute", + "pidBatchMode", + "serveTimeoutSeconds", + "drainDurationSeconds", + "serveToResponseRatio", + "criteria", + "startingElo", + "minResponses", + "maxResponses", + "serveResponses", + "featureFlags", + "ownerId", + "ownerMail", + "organizationId", + "createdAt", + "_t" ], - "type": "object", "properties": { - "identifier": { + "_t": { + "enum": [ + "RankingFlow" + ], + "type": "string" + }, + "id": { "type": "string", - "description": "An identifier associated with the prompt." + "description": "The unique identifier of the flow." }, - "prompt": { + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/FlowType" + } + ], + "description": "The type of the flow. Use the _t discriminator instead.", + "deprecated": true + }, + "name": { "type": "string", - "description": "The prompt text.", + "description": "The name of the flow." + }, + "campaignId": { + "type": "string", + "description": "The ID of the campaign associated with this flow." + }, + "flowItemCount": { + "type": "integer", + "description": "The total number of items that have been added to this flow. Incremented atomically on each item creation.", + "format": "int64" + }, + "targetResponseCount": { + "type": "integer", + "description": "Target average response count per completed item. Enables PID-based automatic rate control when set. Null disables PID.", + "format": "int32", "nullable": true }, - "promptAsset": { + "pidProportionalGain": { + "type": "number", + "description": "PID proportional gain. Controls how strongly the rate reacts to the current error between target and actual response counts.", + "format": "double" + }, + "pidIntegralGain": { + "type": "number", + "description": "PID integral gain. Eliminates steady-state error by accumulating error over time. Includes anti-windup clamping.", + "format": "double" + }, + "pidDerivativeGain": { + "type": "number", + "description": "PID derivative gain. Provides damping by reacting to the rate of change of the error, helping prevent overshoot.", + "format": "double" + }, + "pidOutputOffset": { + "type": "number", + "description": "Constant offset added to the PID output before clamping, shifting the controller's operating point so the P/I/D terms trim around a non-zero baseline.", + "format": "double" + }, + "pidMinSessionsPerMinute": { + "type": "integer", + "description": "Minimum sessions per minute the PID controller can set. Prevents the rate from dropping to zero.", + "format": "int32" + }, + "pidMaxSessionsPerMinute": { + "type": "integer", + "description": "Maximum sessions per minute the PID controller can set. Prevents the rate from exceeding infrastructure capacity.", + "format": "int32" + }, + "pidBatchMode": { "allOf": [ { - "$ref": "#/components/schemas/IAssetInput" + "$ref": "#/components/schemas/PidBatchMode" } ], - "description": "The asset associated with the prompt." + "description": "How the PID output maps to the campaign rate. Total: used directly. PerBatch: multiplied by active item count. PerBatchTimeWeighted: multiplied by time-weighted active item count based on remaining TTL." }, - "tags": { + "serveTimeoutSeconds": { + "type": "integer", + "description": "Maximum time in seconds a user has to submit an answer after loading the task. Null uses the system-wide default.", + "format": "int32", + "nullable": true + }, + "drainDurationSeconds": { + "type": "integer", + "description": "Grace period in seconds after an item stops receiving new serves, allowing in-flight responses to complete.", + "format": "int32" + }, + "serveToResponseRatio": { + "type": "number", + "description": "Ratio of serves to responses used to calculate how many tasks to serve per expected response.", + "format": "double", + "nullable": true + }, + "globalBoostLevel": { + "type": "integer", + "description": "Priority multiplier for the flow's campaign. Higher values increase annotator compensation to attract more responses.", + "format": "int32", + "nullable": true, + "deprecated": true + }, + "audienceBoosts": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/AudienceBoost2" }, "nullable": true } ], - "description": "The tags associated with the prompt." + "description": "Audience-specific boost levels that override the global boost for targeted demographics.", + "deprecated": true }, - "origin": { + "audienceId": { + "type": "string", + "description": "Optional audience ID. When provided, the flow will only serve items to users in this audience.", + "nullable": true, + "deprecated": true + }, + "criteria": { + "type": "string", + "description": "The comparison instruction shown to annotators during ranking tasks (e.g. \"Which image is sharper?\").", + "nullable": true + }, + "startingElo": { + "type": "integer", + "description": "The initial Elo rating assigned to new items entering the ranking. Standard default is 1200.", + "format": "int32" + }, + "kFactor": { + "type": "integer", + "description": "Elo K-factor controlling rating volatility. Higher values cause larger rating changes per comparison. Used as a direct multiplier on the Elo change formula.", + "format": "int32", + "deprecated": true + }, + "scalingFactor": { + "type": "integer", + "description": "Elo scaling factor that determines how rating differences translate to expected win probabilities. A difference equal to the scaling factor gives the higher-rated item approximately 90% expected win rate.", + "format": "int32", + "deprecated": true + }, + "minResponses": { + "type": "integer", + "description": "Minimum number of responses a ranking item must receive before it is considered sufficiently evaluated.", + "format": "int32" + }, + "maxResponses": { + "type": "integer", + "description": "Maximum number of responses a ranking item can receive before being removed from active ranking. Null allows unlimited responses.", + "format": "int32", + "nullable": true + }, + "serveResponses": { + "type": "integer", + "description": "Number of accepted responses per rapid at which to stop serving. Null defaults to MaxResponses.", + "format": "int32", + "nullable": true + }, + "featureFlags": { "allOf": [ { - "$ref": "#/components/schemas/Origin" + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } } ], - "description": "Where the prompt came from." - } - } - }, - "CreatePromptForBenchmarkEndpoint_Output": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { + "description": "Key-value feature flags that enable specific behaviors for this flow (e.g. rapid_hints)." + }, + "ownerId": { "type": "string", - "description": "The id of the created prompt." - } - } - }, - "CreatePromptForLeaderboardEndpoint_Output": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { + "description": "The ID of the customer who owns the flow.", + "format": "uuid" + }, + "ownerMail": { "type": "string", - "description": "The id of the created prompt." + "description": "The email of the customer who owns the flow." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the flow was created.", + "format": "date-time" } } }, - "CreateSampleEndpoint_Input": { - "required": [ - "identifier", - "asset" - ], + "PidBatchMode": { + "enum": [ + "Total", + "PerBatch", + "PerBatchTimeWeighted" + ] + }, + "ProblemDetails": { "type": "object", "properties": { - "identifier": { + "type": { "type": "string", - "description": "The identifier used to correlate samples of different participants." + "nullable": true }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "The asset input for the sample." + "title": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "instance": { + "type": "string", + "nullable": true } } }, - "CreateSampleEndpoint_Output": { + "QueryFlowItemsEndpoint_Output": { "required": [ - "id" + "id", + "datasetId", + "state", + "createdAt" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The id of the created sample." - } - } - }, - "CreateSampleGenerationEndpoint_Input": { - "required": [ - "samplesPerPrompt" - ], - "type": "object", - "properties": { - "samplesPerPrompt": { - "type": "integer", - "description": "How many samples to request per matching prompt (1 to 16).", - "format": "int32" + "description": "The unique identifier of the flow item." }, - "participantIds": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - ], - "description": "Restrict generation to specific participants. Defaults to all participants\n in the benchmark that have a configured faucet." + "datasetId": { + "type": "string", + "description": "The ID of the dataset used by this flow item." }, - "promptIdentifiers": { + "workflowId": { + "type": "string", + "description": "The ID of the workflow created for this flow item.", + "nullable": true + }, + "state": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "$ref": "#/components/schemas/FlowItemState" } ], - "description": "Restrict generation to specific prompt identifiers.\n Defaults to every prompt in the benchmark." + "description": "The current state of the flow item." }, - "tags": { + "context": { + "type": "string", + "description": "Optional context associated with this flow item.", + "nullable": true + }, + "contextAsset": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "$ref": "#/components/schemas/IAsset" } ], - "description": "Restrict generation to prompts having at least one of these tags." + "description": "Optional asset context associated with this flow item." + }, + "failureMessage": { + "type": "string", + "description": "The failure message if the flow item failed.", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the flow item was created.", + "format": "date-time" + }, + "startedAt": { + "type": "string", + "description": "The timestamp when the flow item started processing.", + "format": "date-time", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "The timestamp when the flow item completed.", + "format": "date-time", + "nullable": true + }, + "failedAt": { + "type": "string", + "description": "The timestamp when the flow item failed.", + "format": "date-time", + "nullable": true } } }, - "CreateSampleGenerationEndpoint_Output": { + "QueryFlowItemsEndpoint_PagedResultOfOutput": { "required": [ - "id", - "totalCount", - "skippedParticipantIds" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The id of the created sample generation request." + "total": { + "type": "integer", + "format": "int64" }, - "totalCount": { + "page": { "type": "integer", - "description": "The total number of generation items that were queued.", "format": "int32" }, - "skippedParticipantIds": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Participants that matched the selection but were skipped because they have no faucet\n configured. Empty when explicit participant ids were supplied." + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryFlowItemsEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "CreateSampleNewEndpoint_Input": { + "QueryFlowsEndpoint_Output": { "required": [ - "identifier", - "asset" + "id", + "name", + "type", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], "type": "object", "properties": { - "identifier": { + "id": { "type": "string", - "description": "The identifier used to correlate samples of different participants." + "description": "The unique identifier of the flow." }, - "asset": { + "name": { + "type": "string", + "description": "The name of the flow." + }, + "type": { "allOf": [ { - "$ref": "#/components/schemas/IAssetInput" + "$ref": "#/components/schemas/FlowType" } ], - "description": "The asset input for the sample." - } - } - }, - "CreateSampleNewEndpoint_Output": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { + "description": "The type of the flow." + }, + "ownerId": { "type": "string", - "description": "The id of the created sample." + "description": "The ID of the customer who owns the flow.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The email of the customer who owns the flow." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the flow was created.", + "format": "date-time" } } }, - "ForkBenchmarkEndpoint_Output": { + "QueryFlowsEndpoint_PagedResultOfOutput": { "required": [ - "id" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The id of the new benchmark created." + "total": { + "type": "integer", + "format": "int64" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryFlowsEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "GetBenchmarkByIdEndpoint_Output": { - "required": [ - "id", - "name", - "description", - "isPublic", - "isPublished", - "createdAt", - "initialBoostLevel", - "scoreShift", - "scoreScale", - "lastUpdatedAt" - ], + "UpdateConfigEndpoint_Input": { "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the benchmark." - }, - "name": { + "audienceId": { "type": "string", - "description": "The name of the benchmark." + "description": "Optional audience ID. When provided, the flow will only serve items to users in this audience. Set to null to remove the audience restriction.", + "nullable": true }, - "description": { + "criteria": { "type": "string", - "description": "Optional plain-text credit for the people or sources behind the benchmark. Null when no\n description was supplied.", - "nullable": true + "description": "The ranking criteria used to compare items." }, - "isPublic": { - "type": "boolean", - "description": "Whether the benchmark is public." + "startingElo": { + "type": "integer", + "description": "Initial Elo rating for new items.", + "format": "int32" }, - "isPublished": { - "type": "boolean", - "description": "Whether the benchmark is published to the public benchmark repository." + "minResponses": { + "type": "integer", + "description": "Minimum number of responses per comparison.", + "format": "int32" }, - "createdAt": { - "type": "string", - "description": "The timestamp when the benchmark was created.", - "format": "date-time" + "maxResponses": { + "type": "integer", + "description": "Maximum number of responses per comparison.", + "format": "int32" }, - "ownerId": { - "type": "string", - "description": "The id of the customer owning the benchmark. Null unless the caller is platform staff or a member of the owning organization.", - "format": "uuid", + "serveResponses": { + "type": "integer", + "description": "Number of accepted responses per rapid at which to stop serving. Set to null to remove. Must be less than or equal to MaxResponses when both are set.", + "format": "int32", "nullable": true }, - "ownerMail": { - "type": "string", - "description": "The mail of the customer owning the benchmark. Null unless the caller is platform staff or a member of the owning organization.", + "serveToResponseRatio": { + "type": "number", + "description": "Ratio of concurrent serves to max responses. Set to null to remove the limit.", + "format": "double", "nullable": true }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.", + "serveTimeoutSeconds": { + "type": "integer", + "description": "Time in seconds a user has to submit an answer after loading the task. Set to null to use the global default.", + "format": "int32", "nullable": true }, - "initialBoostLevel": { + "responsesRequired": { "type": "integer", - "description": "The initial boost level applied to the campaign of every run created from this\n benchmark. Null means the benchmark default is used.", + "description": "Deprecated. Use MaxResponses instead.", + "format": "int32", + "deprecated": true + }, + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + } + ], + "description": "Feature flags to enable for this flow." + }, + "targetResponseCount": { + "type": "integer", + "description": "Target average response count per completed item. Set to null to disable PID control.", "format": "int32", "nullable": true }, - "scoreShift": { + "pidProportionalGain": { "type": "number", - "description": "Additive offset applied to displayed scores on the overall scoreboard of this\n benchmark.", + "description": "PID proportional gain.", "format": "double" }, - "scoreScale": { + "pidIntegralGain": { "type": "number", - "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on the overall scoreboard of this benchmark.", + "description": "PID integral gain.", "format": "double" }, - "lastUpdatedAt": { - "type": "string", - "description": "When the benchmark's rankings last changed: the latest vote recording across the\n leaderboards contributing to its overall. Null when none of them ever received votes.", - "format": "date-time", - "nullable": true - } - } - }, - "GetBenchmarkDemographicsEndpoint_Output": { - "required": [ - "totalVotes", - "dimensions" - ], - "type": "object", - "properties": { - "totalVotes": { + "pidDerivativeGain": { + "type": "number", + "description": "PID derivative gain.", + "format": "double" + }, + "pidOutputOffset": { + "type": "number", + "description": "Constant offset added to the PID output before clamping, shifting the controller's operating point.", + "format": "double" + }, + "pidMinSessionsPerMinute": { "type": "integer", - "description": "The total votes behind the composition.", - "format": "int64" + "description": "Minimum sessions per minute the PID can set.", + "format": "int32" }, - "dimensions": { + "pidMaxSessionsPerMinute": { + "type": "integer", + "description": "Maximum sessions per minute the PID can set.", + "format": "int32" + }, + "pidBatchMode": { "allOf": [ { - "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_DimensionSet" + "$ref": "#/components/schemas/PidBatchMode" } ], - "description": "The per-dimension bucket breakdowns." + "description": "How PID output maps to campaign rate. Total: direct rate. PerBatch: multiplied by active batch count. PerBatchTimeWeighted: multiplied by time-weighted batch count." } - }, - "description": "The demographic composition of a benchmark's votes." + } }, - "GetBenchmarkDemographicsEndpoint_Output_Bucket": { + "AcceptOrgInvitationEndpoint_Input": { "required": [ - "value", - "votes", - "share" + "token" ], "type": "object", "properties": { - "value": { - "type": "string" - }, - "votes": { - "type": "integer", - "format": "int64" - }, - "share": { - "type": "number", - "format": "double" + "token": { + "type": "string", + "description": "The single-use invitation token." } } }, - "GetBenchmarkDemographicsEndpoint_Output_DimensionSet": { + "AcceptOrgInvitationEndpoint_Output": { "required": [ - "ageBucket", - "gender", - "occupation", - "country", - "language" + "organizationId", + "membershipId" ], "type": "object", "properties": { - "ageBucket": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" - } - }, - "gender": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" - } - }, - "occupation": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" - } - }, - "country": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" - } + "organizationId": { + "type": "string", + "description": "The organization the customer joined." }, - "language": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" - } + "membershipId": { + "type": "string", + "description": "The id of the created membership." } } }, - "GetBenchmarkHuggingFaceSyncEndpoint_Output": { + "AuthorizationRelations_Bidder": { + "enum": [ + "Admin", + "Editor", + "Viewer" + ], + "description": "Relations on the singleton `bidder` object that carries global RTB access. Grants are\ndirect here and, unlike Organization, are never folded in from platform staff." + }, + "AuthorizationRelations_ExternalApp": { + "enum": [ + "Admin", + "Viewer" + ], + "description": "Relations on an `external_app` object — one object per third-party app that federates\non the OIDC `groups` claim. The apps themselves are `ExternalAppId`. The ladder is hierarchical: `admin` folds into `viewer`.\nGrants are direct and, like `Bidder`, are never folded in from platform staff —\nholding platform admin must not confer administration of a separate system." + }, + "AuthorizationRelations_Platform": { + "enum": [ + "Admin", + "Viewer" + ], + "description": "Relations on the singleton `platform` object. The model is hierarchical: `admin`\nfolds into `viewer`." + }, + "AuthorizationScope": { + "enum": [ + "Platform", + "Bidder", + "ExternalApp" + ] + }, + "Capability": { + "enum": [ + "SkipContentCheck", + "PreheatBoost", + "ManagedImageFaucet", + "RequestFeatures" + ], + "description": "The named platform-wide capability entitlements a customer can be granted. Each maps to a\n`capability` object in the authorization graph; convert to its object id with\nstring CapabilityExtensions.ToObjectId(Capability capability). Kept as a typed enum so\ncapability grants read explicitly at call sites (and, later, on endpoint contracts) instead of\npassing raw id strings around." + }, + "ChangeOrgMemberRoleEndpoint_Input": { "required": [ - "status" + "role" ], "type": "object", "properties": { - "status": { + "role": { "allOf": [ { - "$ref": "#/components/schemas/HuggingFaceSyncStatus" + "$ref": "#/components/schemas/OrgRole" } ], - "description": "Current lifecycle status (NeverSynced when the benchmark has never been synced)." + "description": "The org-scoped role to assign to the member." + } + } + }, + "Client": { + "required": [ + "client_id", + "client_secret", + "client_id_issued_at", + "client_secret_expires_at", + "redirect_uris", + "grant_types", + "response_types", + "client_name", + "client_uri", + "logo_uri", + "scope", + "contacts", + "tos_uri", + "policy_uri", + "jwks_uri", + "jwks" + ], + "type": "object", + "properties": { + "client_id": { + "type": "string" }, - "outcome": { + "client_secret": { "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/HuggingFaceSyncOutcome" + "nullable": true + }, + "client_id_issued_at": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "client_secret_expires_at": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "redirect_uris": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" } - ], - "description": "Outcome of the last completed attempt, or null when none has completed.", + }, "nullable": true }, - "repoId": { - "type": "string", - "description": "The target HuggingFace repo id (e.g. Rapidata/svg-benchmark), or null.", + "grant_types": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + }, "nullable": true }, - "repoUrl": { - "type": "string", - "description": "URL of the HuggingFace repo, or null when not yet known.", + "response_types": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + }, "nullable": true }, - "prUrl": { + "client_name": { "type": "string", - "description": "URL of the review pull request opened by the last attempt, or null.", "nullable": true }, - "lastSyncedAt": { + "client_uri": { "type": "string", - "description": "When the benchmark was last successfully synced, or null.", - "format": "date-time", "nullable": true }, - "lastError": { + "logo_uri": { "type": "string", - "description": "The error from the last failed attempt, or null.", "nullable": true - } - } - }, - "GetBenchmarkHuggingFaceSyncHistoryEndpoint_Output": { - "required": [ - "id", - "status", - "repoId", - "triggeredBy", - "createdAt" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The attempt id (also the correlation token for its export/sync jobs)." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/HuggingFaceSyncStatus" - } - ], - "description": "Lifecycle status of the attempt." }, - "outcome": { + "scope": { "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/HuggingFaceSyncOutcome" - } - ], - "description": "Outcome once completed, or null while still running or on failure.", + "description": "String containing a space-separated list of scope values\n that the client can use when requesting access tokens.", "nullable": true }, - "repoId": { - "type": "string", - "description": "The HuggingFace repo this attempt targeted." + "contacts": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + ], + "description": "Array of strings representing ways to contact people responsible for this client,\n typically email addresses." }, - "repoUrl": { + "tos_uri": { "type": "string", - "description": "URL of the HuggingFace repo, or null when not yet known.", "nullable": true }, - "prUrl": { + "policy_uri": { "type": "string", - "description": "URL of the review pull request opened by the attempt, or null.", "nullable": true }, - "error": { + "jwks_uri": { "type": "string", - "description": "The error from a failed attempt, or null.", "nullable": true }, - "triggeredBy": { - "type": "string", - "description": "Provenance of the trigger (an admin's mail, or auto-sync)." - }, - "syncedRowCount": { - "type": "integer", - "description": "Rows the worker synced, or null until it reports success.", - "format": "int64", + "jwks": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/JsonWebKeySet" + } + ], "nullable": true - }, - "createdAt": { + } + }, + "description": "The response containing the id and secret of a dynamically registered client.\n Additionally, it contains all registered metadata for the client." + }, + "CreateBridgeTokenEndpoint_Output": { + "required": [ + "readKey", + "writeKey" + ], + "type": "object", + "properties": { + "readKey": { "type": "string", - "description": "When the attempt was started.", - "format": "date-time" + "description": "The read key used to retrieve the authentication result." }, - "completedAt": { + "writeKey": { "type": "string", - "description": "When the attempt reached a terminal state, or null while still running.", - "format": "date-time", + "description": "The write key used to store the authentication result." + } + } + }, + "CreateClientEndpoint_Input": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "An optional display name for the client.", "nullable": true } } }, - "GetBenchmarkHuggingFaceSyncHistoryEndpoint_PagedResultOfOutput": { + "CreateClientEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "items" + "clientId", + "clientSecret" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkHuggingFaceSyncHistoryEndpoint_Output" - } + "clientId": { + "type": "string", + "description": "The id of the created client." }, - "totalPages": { - "type": "integer", - "format": "int32" + "clientSecret": { + "type": "string", + "description": "The secret of the created client." } } }, - "GetBenchmarkMatchupBreakdownEndpoint_Output": { + "CreateOrganizationEndpoint_Input": { "required": [ - "promptIdentifier", - "rawWinsA", - "rawWinsB", - "weightedWinsA", - "weightedWinsB", - "effectiveN", - "wilsonCenter" + "name", + "slug" ], "type": "object", "properties": { - "promptId": { - "type": "string", - "description": "The prompt entity id, or null when the identifier has no live prompt.", - "nullable": true - }, - "promptIdentifier": { + "name": { "type": "string", - "description": "The stable identifier of the prompt within the benchmark." + "description": "The human-readable name of the organization." }, - "englishPrompt": { + "slug": { "type": "string", - "description": "The prompt text translated to English, if any.", - "nullable": true + "description": "A URL-safe unique identifier for the organization." }, - "originalPrompt": { + "primaryDomain": { "type": "string", - "description": "The prompt text as originally provided, if any.", + "description": "The primary email domain associated with the organization, if any.", "nullable": true - }, - "promptAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The optional media asset shown with the prompt." - }, - "rawWinsA": { - "type": "integer", - "description": "The number of votes A won on this prompt.", - "format": "int64" - }, - "rawWinsB": { - "type": "integer", - "description": "The number of votes B won on this prompt.", - "format": "int64" - }, - "weightedWinsA": { - "type": "number", - "description": "The reliability-weighted wins for A (summed annotator userScore).", - "format": "double" - }, - "weightedWinsB": { - "type": "number", - "description": "The reliability-weighted wins for B (summed annotator userScore).", - "format": "double" - }, - "effectiveN": { - "type": "number", - "description": "The reliability-weighted sample size, WeightedWinsA + WeightedWinsB.", - "format": "double" - }, - "wilsonCenter": { - "type": "number", - "description": "The Wilson score interval center for A's win share.", - "format": "double" } - }, - "description": "One prompt's A-vs-B split with its render fields and vote stats." + } }, - "GetBenchmarkMatchupBreakdownEndpoint_PagedResultOfOutput": { + "CreateOrganizationEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "items" + "organizationId" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkMatchupBreakdownEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" + "organizationId": { + "type": "string", + "description": "The id of the created organization." } } }, - "GetBenchmarkStandingsBreakdownEndpoint_Output": { - "required": [ - "dimension", - "global", - "segments" - ], + "DynamicClientRegistrationRequest": { "type": "object", "properties": { - "dimension": { - "allOf": [ - { - "$ref": "#/components/schemas/BenchmarkDemographicDimension" - } - ], - "description": "The dimension the standings are split by." + "redirect_uris": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, - "global": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkStandingsBreakdownEndpoint_Output_OutputItem" - } - } - ], - "description": "The standings over the whole filtered set, ordered by score descending." + "grant_types": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, - "segments": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkStandingsBreakdownEndpoint_Output_Segment" - } - } - ], - "description": "The standings per dimension value, ordered by votes descending with unknown last." - } - }, - "description": "The standings broken down by a demographic dimension." - }, - "GetBenchmarkStandingsBreakdownEndpoint_Output_OutputItem": { - "required": [ - "id", - "name", - "status", - "score", - "wins", - "totalMatches", - "isDisabled" - ], - "type": "object", - "properties": { - "id": { - "type": "string" + "response_types": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, - "name": { - "type": "string" + "client_id": { + "type": "string", + "nullable": true }, - "family": { + "client_name": { "type": "string", "nullable": true }, - "lab": { + "client_uri": { "type": "string", "nullable": true }, - "proprietaryName": { + "logo_uri": { "type": "string", "nullable": true }, - "licenseType": { + "scope": { "type": "string", - "oneOf": [ + "description": "String containing a space-separated list of scope values\n that the client can use when requesting access tokens.", + "nullable": true + }, + "contacts": { + "allOf": [ { - "$ref": "#/components/schemas/ModelLicenseType" + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } ], - "nullable": true + "description": "Array of strings representing ways to contact people responsible for this client,\n typically email addresses." }, - "logo": { + "tos_uri": { "type": "string", "nullable": true }, - "status": { - "$ref": "#/components/schemas/StandingStatus" - }, - "score": { - "type": "number", - "format": "double", + "policy_uri": { + "type": "string", "nullable": true }, - "wins": { - "type": "number", - "format": "double" - }, - "totalMatches": { - "type": "number", - "format": "double" - }, - "isDisabled": { - "type": "boolean" + "jwks_uri": { + "type": "string", + "nullable": true }, - "confidenceInterval": { - "type": "object", - "oneOf": [ + "jwks": { + "allOf": [ { - "$ref": "#/components/schemas/ConfidenceInterval" + "$ref": "#/components/schemas/JsonWebKeySet" } ], - "nullable": true + "description": "Client's JSON Web Key Set [RFC7517] document value, which contains the client's public keys." } - } + }, + "description": "The request body for dynamic client registration." }, - "GetBenchmarkStandingsBreakdownEndpoint_Output_Segment": { + "ExternalAppId": { + "enum": [ + "ArgoCd", + "Grafana" + ], + "description": " The third-party applications that federate on our OIDC `groups` claim and can therefore\n be administered through a grant here. Each maps to an `external_app` object in the\n authorization graph.\n A closed enum rather than a free-form id on purpose: an arbitrary string would let a typo\nwrite a grant against an object nothing consumes, which looks like access was granted but\nsilently is not. Adding an app is a value here plus a tuple — no model change.This is the app itself; the relation vocabulary defined on these objects is\nAuthorizationRelations.ExternalApp. The Id suffix here keeps the two\ndistinguishable: a file with using static AuthorizationRelations imports that\nnested enum, and identical short names would make every bare mention ambiguous." + }, + "GetBidderRelationMembersEndpoint_CursorPagedResultOfOutput": { "required": [ - "value", - "votes", "items" ], "type": "object", "properties": { - "value": { - "type": "string" - }, - "votes": { - "type": "integer", - "format": "int64" - }, "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetBenchmarkStandingsBreakdownEndpoint_Output_OutputItem" + "$ref": "#/components/schemas/GetBidderRelationMembersEndpoint_Output" } + }, + "nextCursor": { + "type": "string", + "nullable": true } - } + }, + "description": "A page of results identified by an opaque cursor rather than an offset. Used where the\nunderlying store pages by continuation token and a total count is unavailable or expensive.\nstring? CursorPagedResult<T>.NextCursor is null on the last page." }, - "GetBenchmarkStandingsByTagEndpoint_Output": { + "GetBidderRelationMembersEndpoint_Output": { "required": [ - "global", - "totalResponses", - "segments" + "customer", + "email", + "organizationName", + "organizationId", + "scope", + "relation", + "grantedAt" ], "type": "object", "properties": { - "global": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkStandingsByTagEndpoint_Output_OutputItem" - } - } - ], - "description": "The standings over the whole filtered set, ordered by score descending." + "customer": { + "type": "string", + "description": "The customer holding the relation.", + "format": "uuid" }, - "totalResponses": { - "type": "integer", - "description": "Total raw human responses (votes) behind Global under the current filter —\n the actual response count, not the per-participant TotalMatches (which counts\n binarized matchups, so a comparison's several votes collapse into one).", - "format": "int64" + "email": { + "type": "string", + "description": "The email address of the customer." }, - "segments": { + "organizationName": { + "type": "string", + "description": "The name of the customer's active organization." + }, + "organizationId": { + "type": "string", + "description": "The identifier of the customer's active organization." + }, + "scope": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBenchmarkStandingsByTagEndpoint_Output_Segment" - } + "$ref": "#/components/schemas/AuthorizationScope" } ], - "description": "The standings per tag, ordered by votes descending." + "description": "The object the relation is on." + }, + "relation": { + "$ref": "#/components/schemas/AuthorizationRelations_Bidder" + }, + "grantedAt": { + "type": "string", + "description": "When the grant was written.", + "format": "date-time" } - }, - "description": "The standings sliced by prompt tag." + } }, - "GetBenchmarkStandingsByTagEndpoint_Output_OutputItem": { + "GetCapabilityGranteesEndpoint_CursorPagedResultOfOutput": { "required": [ - "id", - "name", - "status", - "score", - "wins", - "totalMatches", - "responseCount", - "isEvaluating", - "isDisabled" + "items" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "family": { - "type": "string", - "nullable": true + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetCapabilityGranteesEndpoint_Output" + } }, - "lab": { + "nextCursor": { "type": "string", "nullable": true - }, - "proprietaryName": { + } + }, + "description": "A page of results identified by an opaque cursor rather than an offset. Used where the\nunderlying store pages by continuation token and a total count is unavailable or expensive.\nstring? CursorPagedResult<T>.NextCursor is null on the last page." + }, + "GetCapabilityGranteesEndpoint_Output": { + "required": [ + "organizationId", + "organizationName", + "timestamp" + ], + "type": "object", + "properties": { + "organizationId": { "type": "string", - "nullable": true + "description": "The organization that holds the capability." }, - "licenseType": { + "organizationName": { "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ModelLicenseType" - } - ], - "nullable": true + "description": "The human-readable name of the organization." }, - "logo": { + "timestamp": { "type": "string", - "nullable": true - }, - "status": { - "$ref": "#/components/schemas/StandingStatus" - }, - "score": { - "type": "number", - "format": "double", - "nullable": true - }, - "wins": { - "type": "number", - "format": "double" - }, - "totalMatches": { - "type": "number", - "format": "double" - }, - "responseCount": { - "type": "integer", - "format": "int64" - }, - "isEvaluating": { - "type": "boolean" - }, - "isDisabled": { - "type": "boolean" - }, - "confidenceInterval": { - "type": "object", - "oneOf": [ + "description": "When the grant was written.", + "format": "date-time" + } + } + }, + "GetCustomerCapabilitiesEndpoint_Output": { + "required": [ + "capabilities" + ], + "type": "object", + "properties": { + "capabilities": { + "allOf": [ { - "$ref": "#/components/schemas/ConfidenceInterval" + "type": "array", + "items": { + "$ref": "#/components/schemas/Capability" + } } ], - "nullable": true + "description": "Capabilities granted to the organization the customer is acting under." } } }, - "GetBenchmarkStandingsByTagEndpoint_Output_Segment": { + "GetExternalAppRelationMembersEndpoint_CursorPagedResultOfOutput": { "required": [ - "value", - "promptCount", - "votes", "items" ], "type": "object", "properties": { - "value": { - "type": "string" - }, - "axis": { - "type": "string", - "nullable": true - }, - "promptCount": { - "type": "integer", - "format": "int32" - }, - "votes": { - "type": "integer", - "format": "int64" - }, "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetBenchmarkStandingsByTagEndpoint_Output_SegmentItem" + "$ref": "#/components/schemas/GetExternalAppRelationMembersEndpoint_Output" } + }, + "nextCursor": { + "type": "string", + "nullable": true } - } + }, + "description": "A page of results identified by an opaque cursor rather than an offset. Used where the\nunderlying store pages by continuation token and a total count is unavailable or expensive.\nstring? CursorPagedResult<T>.NextCursor is null on the last page." }, - "GetBenchmarkStandingsByTagEndpoint_Output_SegmentItem": { + "GetExternalAppRelationMembersEndpoint_Output": { "required": [ - "id", - "score", - "wins", - "totalMatches", - "responseCount", - "isDisabled" + "customer", + "email", + "organizationName", + "organizationId", + "scope", + "app", + "relation", + "grantedAt" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "score": { - "type": "number", - "format": "double", - "nullable": true - }, - "wins": { - "type": "number", - "format": "double" + "customer": { + "type": "string", + "description": "The customer holding the relation.", + "format": "uuid" }, - "totalMatches": { - "type": "number", - "format": "double" + "email": { + "type": "string", + "description": "The email address of the customer." }, - "responseCount": { - "type": "integer", - "format": "int64" + "organizationName": { + "type": "string", + "description": "The name of the customer's active organization." }, - "isDisabled": { - "type": "boolean" + "organizationId": { + "type": "string", + "description": "The identifier of the customer's active organization." }, - "confidenceInterval": { - "type": "object", - "oneOf": [ + "scope": { + "allOf": [ { - "$ref": "#/components/schemas/ConfidenceInterval" + "$ref": "#/components/schemas/AuthorizationScope" } ], - "nullable": true + "description": "The object the relation is on." + }, + "app": { + "$ref": "#/components/schemas/ExternalAppId" + }, + "relation": { + "$ref": "#/components/schemas/AuthorizationRelations_ExternalApp" + }, + "grantedAt": { + "type": "string", + "description": "When the grant was written.", + "format": "date-time" } } }, - "GetCombinedBenchmarkMatrixEndpoint_Output": { + "GetOrganizationCapabilitiesEndpoint_Output": { "required": [ - "index", - "columns", - "data" + "capabilities" ], "type": "object", "properties": { - "index": { + "capabilities": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/Capability" } } ], - "description": "Row participant names." + "description": "The capabilities granted to the organization, held by all of its members." + } + } + }, + "GetOrganizationEndpoint_Output": { + "required": [ + "id", + "name", + "slug", + "primaryDomain" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the organization." }, - "columns": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Column participant names." + "name": { + "type": "string", + "description": "The human-readable name of the organization." }, - "data": { - "allOf": [ - { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - } - ], - "description": "NxN matrix where Data[i][j] = wins of Index[i] over Columns[j]." + "slug": { + "type": "string", + "description": "The URL-safe unique identifier of the organization." + }, + "primaryDomain": { + "type": "string", + "description": "The primary email domain associated with the organization, if any.", + "nullable": true } - }, - "description": "Combined benchmark matrix output in pandas split format." + } }, - "GetCombinedBenchmarkStandingsEndpoint_Output": { + "GetPlatformRelationMembersEndpoint_CursorPagedResultOfOutput": { "required": [ "items" ], "type": "object", "properties": { "items": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetCombinedBenchmarkStandingsEndpoint_OutputItem" - } - } - ], - "description": "The standings items." + "type": "array", + "items": { + "$ref": "#/components/schemas/GetPlatformRelationMembersEndpoint_Output" + } + }, + "nextCursor": { + "type": "string", + "nullable": true } }, - "description": "Combined benchmark standings output." + "description": "A page of results identified by an opaque cursor rather than an offset. Used where the\nunderlying store pages by continuation token and a total count is unavailable or expensive.\nstring? CursorPagedResult<T>.NextCursor is null on the last page." }, - "GetCombinedBenchmarkStandingsEndpoint_OutputItem": { + "GetPlatformRelationMembersEndpoint_Output": { "required": [ - "id", - "name", - "status", - "score", - "wins", - "totalMatches", - "isDisabled" + "customer", + "email", + "organizationName", + "organizationId", + "scope", + "relation", + "grantedAt" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "family": { + "customer": { "type": "string", - "nullable": true + "description": "The customer holding the relation.", + "format": "uuid" }, - "lab": { + "email": { "type": "string", - "nullable": true + "description": "The email address of the customer." }, - "proprietaryName": { + "organizationName": { "type": "string", - "nullable": true + "description": "The name of the customer's active organization." }, - "licenseType": { + "organizationId": { "type": "string", - "oneOf": [ + "description": "The identifier of the customer's active organization." + }, + "scope": { + "allOf": [ { - "$ref": "#/components/schemas/ModelLicenseType" + "$ref": "#/components/schemas/AuthorizationScope" } ], - "nullable": true + "description": "The object the relation is on." }, - "logo": { - "type": "string", - "nullable": true + "relation": { + "$ref": "#/components/schemas/AuthorizationRelations_Platform" }, - "status": { - "$ref": "#/components/schemas/StandingStatus" + "grantedAt": { + "type": "string", + "description": "When the grant was written.", + "format": "date-time" + } + } + }, + "GoogleOneTapLoginEndpoint_Input": { + "required": [ + "idToken" + ], + "type": "object", + "properties": { + "idToken": { + "type": "string", + "description": "The id token received from the Google One Tap login." + } + } + }, + "GoogleOneTapLoginEndpoint_Output": { + "required": [ + "requiresEmailConfirmation" + ], + "type": "object", + "properties": { + "requiresEmailConfirmation": { + "type": "boolean", + "description": "Whether the account still requires email confirmation." }, - "score": { - "type": "number", - "format": "double", + "email": { + "type": "string", + "description": "The email of the signed-in user, if available.", "nullable": true + } + } + }, + "GrantBidderRelationEndpoint_Input": { + "required": [ + "customer", + "relation" + ], + "type": "object", + "properties": { + "customer": { + "type": "string", + "description": "The customer to grant the relation to.", + "format": "uuid" }, - "wins": { - "type": "number", - "format": "double" - }, - "totalMatches": { - "type": "number", - "format": "double" + "relation": { + "$ref": "#/components/schemas/AuthorizationRelations_Bidder" + } + } + }, + "GrantExternalAppRelationEndpoint_Input": { + "required": [ + "customer", + "app", + "relation" + ], + "type": "object", + "properties": { + "customer": { + "type": "string", + "description": "The customer to grant the relation to.", + "format": "uuid" }, - "isDisabled": { - "type": "boolean" + "app": { + "$ref": "#/components/schemas/ExternalAppId" }, - "confidenceInterval": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/ConfidenceInterval" - } - ], - "nullable": true + "relation": { + "$ref": "#/components/schemas/AuthorizationRelations_ExternalApp" } } }, - "GetCombinedLeaderboardMatrixEndpoint_Output": { + "GrantPlatformRelationEndpoint_Input": { "required": [ - "index", - "columns", - "data" + "customer", + "relation" ], "type": "object", "properties": { - "index": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Row participant names." - }, - "columns": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Column participant names." + "customer": { + "type": "string", + "description": "The customer to grant the relation to.", + "format": "uuid" }, - "data": { - "allOf": [ - { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - } - ], - "description": "NxN matrix where Data[i][j] = wins of Index[i] over Columns[j]." + "relation": { + "$ref": "#/components/schemas/AuthorizationRelations_Platform" } - }, - "description": "Combined leaderboard matrix output in pandas split format." + } }, - "GetCombinedLeaderboardStandingsEndpoint_Output": { + "InviteOrgMemberEndpoint_Input": { "required": [ - "items" + "email", + "role" ], "type": "object", "properties": { - "items": { + "email": { + "type": "string", + "description": "The email address to invite." + }, + "role": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetCombinedLeaderboardStandingsEndpoint_OutputItem" - } + "$ref": "#/components/schemas/OrgRole" } ], - "description": "The standings items." + "description": "The org-scoped role the resulting membership will confer." } - }, - "description": "Combined leaderboard standings output." + } }, - "GetCombinedLeaderboardStandingsEndpoint_OutputItem": { + "InviteOrgMemberEndpoint_Output": { "required": [ - "id", - "name", - "status", - "score", - "wins", - "totalMatches", - "isDisabled" + "invitationId", + "token", + "expiresAt" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" + "invitationId": { + "type": "string", + "description": "The id of the created invitation." }, - "status": { - "$ref": "#/components/schemas/StandingStatus" + "token": { + "type": "string", + "description": "The single-use token used to accept the invitation." }, - "score": { - "type": "number", - "format": "double", + "expiresAt": { + "type": "string", + "description": "The instant after which the invitation can no longer be accepted.", + "format": "date-time" + } + } + }, + "JsonWebKey": { + "type": "object", + "properties": { + "alg": { + "type": "string", "nullable": true }, - "wins": { - "type": "number", - "format": "double" + "crv": { + "type": "string", + "nullable": true }, - "totalMatches": { - "type": "number", - "format": "double" + "d": { + "type": "string", + "nullable": true }, - "isDisabled": { - "type": "boolean" + "dp": { + "type": "string", + "nullable": true }, - "confidenceInterval": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/ConfidenceInterval" - } - ], + "dq": { + "type": "string", "nullable": true - } - } - }, - "GetLeaderboardByIdEndpoint_Output": { - "required": [ - "id", - "name", - "instruction", - "showPrompt", - "showPromptAsset", - "isInversed", - "responseBudget", - "minResponses", - "audienceId", - "featureFlags", - "weight", - "scoreShift", - "scoreScale", - "isHidden", - "isExcludedFromOverall", - "voteAggregation", - "includedTags", - "excludedTags", - "lastUpdatedAt" - ], - "type": "object", - "properties": { - "id": { + }, + "e": { "type": "string", - "description": "The unique identifier of the leaderboard." + "nullable": true }, - "name": { + "k": { "type": "string", - "description": "The name of the leaderboard." + "nullable": true + }, + "key_ops": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, - "instruction": { + "kid": { "type": "string", - "description": "The instruction used when collecting responses." - }, - "showPrompt": { - "type": "boolean", - "description": "Whether the prompt is shown on the rapids." + "nullable": true }, - "showPromptAsset": { - "type": "boolean", - "description": "Whether the prompt asset is shown on the rapids." + "kty": { + "type": "string", + "nullable": true }, - "isInversed": { - "type": "boolean", - "description": "Whether the leaderboard results are inversed." + "n": { + "type": "string", + "nullable": true }, - "responseBudget": { - "type": "integer", - "description": "The response budget per run.", - "format": "int32" + "oth": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, - "minResponses": { - "type": "integer", - "description": "The minimum responses collected per comparison.", - "format": "int32" + "p": { + "type": "string", + "nullable": true }, - "audienceId": { + "q": { "type": "string", - "description": "The id of the audience that evaluates the leaderboard." + "nullable": true }, - "jobDefinitionId": { + "qi": { "type": "string", - "description": "The id of the associated job definition, if any.", "nullable": true }, - "priority": { - "type": "integer", - "description": "Priority override applied to every run's job. Null when no override is set; runs then\n fall back to the default leaderboard priority.", - "format": "int32", + "use": { + "type": "string", "nullable": true }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "Feature flags applied to orders created from this leaderboard." + "x": { + "type": "string", + "nullable": true }, - "weight": { - "type": "number", - "description": "Multiplier applied to every match result from this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards.", - "format": "double" + "x5c": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, - "scoreShift": { - "type": "number", - "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", - "format": "double" + "x5t": { + "type": "string", + "nullable": true }, - "scoreScale": { - "type": "number", - "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard.", - "format": "double" + "x5t#S256": { + "type": "string", + "nullable": true }, - "isHidden": { - "type": "boolean", - "description": "Whether the leaderboard is hidden in listings and reads for non-admins." + "x5u": { + "type": "string", + "nullable": true }, - "isExcludedFromOverall": { - "type": "boolean", - "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard,\n making it an owner-only private experiment." + "y": { + "type": "string", + "nullable": true }, - "voteAggregation": { - "allOf": [ - { - "$ref": "#/components/schemas/VoteAggregation" - } - ], - "description": "How individual votes on a matchup are aggregated into the stored result." + "pub": { + "type": "string", + "nullable": true }, - "includedTags": { + "priv": { + "type": "string", + "nullable": true + } + } + }, + "JsonWebKeySet": { + "type": "object", + "properties": { + "keys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonWebKey" + }, + "nullable": true + } + } + }, + "ListOrgInvitationsEndpoint_Output": { + "required": [ + "invitations" + ], + "type": "object", + "properties": { + "invitations": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ListOrgInvitationsEndpoint_Output_Invitation" } } ], - "description": "Prompt tag values the leaderboard restricts its matchups to. Empty means no restriction." + "description": "The pending invitations of the organization." + } + } + }, + "ListOrgInvitationsEndpoint_Output_Invitation": { + "required": [ + "invitationId", + "email", + "role", + "expiresAt", + "createdAt" + ], + "type": "object", + "properties": { + "invitationId": { + "type": "string" }, - "excludedTags": { + "email": { + "type": "string" + }, + "role": { + "$ref": "#/components/schemas/OrgRole" + }, + "expiresAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time" + } + } + }, + "ListOrgMembersEndpoint_Output": { + "required": [ + "members" + ], + "type": "object", + "properties": { + "members": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ListOrgMembersEndpoint_Output_Member" } } ], - "description": "Prompt tag values the leaderboard never creates matchups for. Takes precedence over\n includedTags." - }, - "lastUpdatedAt": { - "type": "string", - "description": "When votes were last recorded for the leaderboard. Null when no run has ever delivered\n votes to it.", - "format": "date-time", - "nullable": true + "description": "The members of the organization." } } }, - "GetParticipantByIdEndpoint_Output": { + "ListOrgMembersEndpoint_Output_Member": { "required": [ - "id", - "name", - "benchmarkId", + "customerId", + "email", + "role", "status" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the participant." - }, - "name": { - "type": "string", - "description": "The name of the participant." - }, - "benchmarkId": { + "customerId": { "type": "string", - "description": "The id of the benchmark the participant belongs to." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ParticipantStatus" - } - ], - "description": "The status of the participant." + "format": "uuid" }, - "family": { + "email": { "type": "string", - "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), or null if unset.", "nullable": true }, - "lab": { - "type": "string", - "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"), or null if unset.", - "nullable": true + "role": { + "$ref": "#/components/schemas/OrgRole" }, - "proprietaryName": { + "status": { + "$ref": "#/components/schemas/MembershipStatus" + } + } + }, + "MembershipStatus": { + "enum": [ + "Active", + "Suspended" + ] + }, + "OrgRole": { + "enum": [ + "Owner", + "Admin", + "Editor", + "Viewer" + ] + }, + "QueryAllOrganizationsEndpoint_Output": { + "required": [ + "id", + "name", + "slug", + "memberCount" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "The vendor-facing display name of the model, or null if unset.", - "nullable": true + "description": "The id of the organization." }, - "licenseType": { + "name": { "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ModelLicenseType" - } - ], - "description": "The license classification of the underlying model, or null if not classified yet.", - "nullable": true + "description": "The human-readable name of the organization." }, - "logo": { + "slug": { "type": "string", - "description": "The logo of the model, or null if unset.", - "nullable": true + "description": "The URL-safe unique identifier of the organization." }, - "faucet": { - "allOf": [ - { - "$ref": "#/components/schemas/IFaucetOutput" - } - ], - "description": "The faucet configured to auto-generate samples, or null if none is set." + "memberCount": { + "type": "integer", + "description": "The number of members the organization has.", + "format": "int32" } } }, - "GetPromptEmbeddingMapEndpoint_Output": { + "QueryAllOrganizationsEndpoint_PagedResultOfOutput": { "required": [ - "computedAt", - "promptCount", - "tags", - "points" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "computedAt": { - "type": "string", - "description": "When the map finished computing.", - "format": "date-time" + "total": { + "type": "integer", + "format": "int64" }, - "promptCount": { + "page": { "type": "integer", - "description": "How many prompts the map contains. Prompts without English text are not embedded, so this\n can be lower than the benchmark's prompt total.", "format": "int32" }, - "tags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - } - ], - "description": "The de-duplicated tag vocabulary for the map. Each point's tagIndices are positions\n in this list." + "pageSize": { + "type": "integer", + "format": "int32" }, - "points": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetPromptEmbeddingMapEndpoint_Output_Point" - } - } - ], - "description": "One point per embedded prompt." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryAllOrganizationsEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "GetPromptEmbeddingMapEndpoint_Output_Point": { + "QueryClientsEndpoint_Output": { "required": [ - "promptId", - "x", - "y", - "tagIndices" + "clientId", + "displayName", + "createdAt" ], "type": "object", "properties": { - "promptId": { - "type": "string" - }, - "x": { - "type": "number", - "format": "double" - }, - "y": { - "type": "number", - "format": "double" - }, - "source": { + "clientId": { "type": "string", + "description": "The id of the client.", "nullable": true }, - "prompt": { + "displayName": { "type": "string", + "description": "The optional display name of the client.", "nullable": true }, - "tagIndices": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } + "createdAt": { + "type": "string", + "description": "The time at which the client was created.", + "format": "date-time", + "nullable": true } } }, - "GetPromptEmbeddingMapStatusEndpoint_Output": { + "QueryClientsEndpoint_PagedResultOfOutput": { "required": [ - "id", - "status", - "promptCount" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The id of the benchmark's map." + "total": { + "type": "integer", + "format": "int64" }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/PromptEmbeddingMapStatus" - } - ], - "description": "The state of the most recent computation — not of the map being served. A Pending or\n Failed status still leaves the previously computed map on the public route." + "page": { + "type": "integer", + "format": "int32" }, - "promptCount": { + "pageSize": { "type": "integer", - "description": "How many prompts the map contains. Prompts without English text are not embedded, so this\n can be lower than the benchmark's prompt total. Zero until the first run succeeds.", "format": "int32" }, - "computedAt": { - "type": "string", - "description": "When the points currently being served were computed. Absent until the first run succeeds.", - "format": "date-time", - "nullable": true + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryClientsEndpoint_Output" + } }, - "failureReason": { - "type": "string", - "description": "Why the computation failed, when it did.", - "nullable": true + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "GetPromptsByBenchmarkEndpoint_Output": { + "QueryCustomersEndpoint_Output": { "required": [ "id", - "identifier", - "createdAt", - "tags" + "email", + "organizationName", + "organizationId" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the prompt." + "description": "The unique identifier of the customer.", + "format": "uuid" }, - "prompt": { + "email": { "type": "string", - "description": "The prompt text.", - "nullable": true, - "deprecated": true + "description": "The email address of the customer.", + "nullable": true }, - "englishPrompt": { + "organizationName": { "type": "string", - "description": "The prompt text translated to English.", + "description": "The name of the organization this customer belongs to, if any.", "nullable": true }, - "originalPrompt": { + "organizationId": { "type": "string", - "description": "The prompt text as originally provided.", + "description": "The identifier of the organization this customer belongs to, if any.", "nullable": true + } + } + }, + "QueryCustomersEndpoint_PagedResultOfOutput": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int64" }, - "promptAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The optional asset associated with the prompt." + "page": { + "type": "integer", + "format": "int32" }, - "identifier": { - "type": "string", - "description": "The identifier associated with the prompt." + "pageSize": { + "type": "integer", + "format": "int32" }, - "createdAt": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryCustomersEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" + } + } + }, + "QueryOrganizationsEndpoint_Output": { + "required": [ + "id", + "name", + "slug", + "role" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "The timestamp when the prompt was created.", - "format": "date-time" + "description": "The id of the organization." }, - "tags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - } - ], - "description": "The tags associated with the prompt, each with an optional category." + "name": { + "type": "string", + "description": "The human-readable name of the organization." }, - "origin": { + "slug": { + "type": "string", + "description": "The URL-safe unique identifier of the organization." + }, + "role": { "allOf": [ { - "$ref": "#/components/schemas/Origin" + "$ref": "#/components/schemas/OrgRole" } ], - "description": "Where the prompt came from, if known." + "description": "The caller's role in the organization." } } }, - "GetPromptsByBenchmarkEndpoint_PagedResultOfOutput": { + "QueryOrganizationsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -53259,7 +49608,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetPromptsByBenchmarkEndpoint_Output" + "$ref": "#/components/schemas/QueryOrganizationsEndpoint_Output" } }, "totalPages": { @@ -53268,876 +49617,1121 @@ } } }, - "GetReplicateModelEndpoint_Output": { + "ReadBridgeTokenEndpoint_KeysOutput": { "required": [ - "modelOwner", - "modelName", - "supportsImageReference", - "parameters" + "accessToken", + "expiresIn", + "refreshToken", + "idToken", + "tokenType", + "scope" ], "type": "object", "properties": { - "modelOwner": { + "accessToken": { "type": "string", - "description": "The owner of the hosted model." + "description": "The issued access token.", + "nullable": true }, - "modelName": { + "expiresIn": { + "type": "integer", + "description": "The lifetime of the access token, in seconds.", + "format": "int32", + "nullable": true + }, + "refreshToken": { "type": "string", - "description": "The model name." + "description": "The refresh token used to obtain new access tokens.", + "nullable": true }, - "description": { + "idToken": { "type": "string", - "description": "A short description of the model.", + "description": "The OpenID Connect ID token.", "nullable": true }, - "coverImageUrl": { + "tokenType": { "type": "string", - "description": "URL of a representative cover image, if available.", + "description": "The type of the issued token.", "nullable": true }, - "runCount": { - "type": "integer", - "description": "Total number of times the model has been run on Replicate, if known.", - "format": "int64", + "scope": { + "type": "string", + "description": "The scopes granted to the issued token.", "nullable": true + } + } + }, + "ReadBridgeTokenEndpoint_NotAvailableOutput": { + "required": [ + "message" + ], + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating that the keys are not yet available." + } + } + }, + "RevokeBidderRelationEndpoint_Input": { + "required": [ + "customer", + "relation" + ], + "type": "object", + "properties": { + "customer": { + "type": "string", + "description": "The customer to revoke the relation from.", + "format": "uuid" }, - "latestVersion": { + "relation": { + "$ref": "#/components/schemas/AuthorizationRelations_Bidder" + } + } + }, + "RevokeExternalAppRelationEndpoint_Input": { + "required": [ + "customer", + "app", + "relation" + ], + "type": "object", + "properties": { + "customer": { "type": "string", - "description": "The model's latest version id, if reported by Replicate.", + "description": "The customer to revoke the relation from.", + "format": "uuid" + }, + "app": { + "$ref": "#/components/schemas/ExternalAppId" + }, + "relation": { + "$ref": "#/components/schemas/AuthorizationRelations_ExternalApp" + } + } + }, + "RevokePlatformRelationEndpoint_Input": { + "required": [ + "customer", + "relation" + ], + "type": "object", + "properties": { + "customer": { + "type": "string", + "description": "The customer to revoke the relation from.", + "format": "uuid" + }, + "relation": { + "$ref": "#/components/schemas/AuthorizationRelations_Platform" + } + } + }, + "SendSurveyEndpoint_Input": { + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "allOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + ], + "description": "The fields of the survey." + } + } + }, + "SetOrganizationSupportSlackChannelEndpoint_Input": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The support Slack channel URL to set, or null/empty to clear it.", "nullable": true + } + } + }, + "SubscribeToNewsletterEndpoint_Input": { + "required": [ + "email", + "token" + ], + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "The email of the user to subscribe." }, - "supportsImageReference": { - "type": "boolean", - "description": "Whether the model accepts a reference image that the platform auto-fills with a prompt's\n attached media. When true that input is excluded from Parameters." + "token": { + "type": "string", + "description": "The recaptcha token used to verify the caller is not a bot." + } + } + }, + "SwitchActiveOrganizationEndpoint_Input": { + "required": [ + "organizationId" + ], + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "The id of the organization to activate." + } + } + }, + "UnsubscribeFromNewsletterEndpoint_Input": { + "required": [ + "email", + "token" + ], + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "The email of the user to unsubscribe." }, - "parameters": { + "token": { + "type": "string", + "description": "The recaptcha token used to verify the caller is not a bot." + } + } + }, + "UpdateOrganizationEndpoint_Input": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The new human-readable name, if changing it." + }, + "slug": { + "type": "string", + "description": "The new URL-safe unique identifier, if changing it." + } + } + }, + "BenchmarkDemographicDimension": { + "enum": [ + "AgeBucket", + "Gender", + "Occupation", + "Country", + "Language" + ] + }, + "BoostLeaderboardEndpoint_Input": { + "required": [ + "participants", + "totalResponses" + ], + "type": "object", + "properties": { + "participants": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/GetReplicateModelEndpoint_Parameter" + "type": "string" } } ], - "description": "The model's configurable input parameters, ordered for rendering." + "description": "The participants of the given leaderboard that should be boosted." + }, + "totalResponses": { + "type": "integer", + "description": "The total responses to add, shared across all participants.", + "format": "int32" + }, + "seed": { + "type": "integer", + "description": "Optional seed for deterministic matchup selection. Use the same value across leaderboards\n of a benchmark to have them boosted on the same image pairs. Omit for random selection.", + "format": "int64", + "nullable": true } } }, - "GetReplicateModelEndpoint_Parameter": { + "ConfidenceInterval": { "required": [ - "key", - "type", - "required", - "enumValues" + "lowerOffset", + "upperOffset" ], "type": "object", "properties": { - "key": { - "type": "string" + "lowerOffset": { + "type": "number", + "format": "double" }, - "title": { + "upperOffset": { + "type": "number", + "format": "double" + } + } + }, + "CreateBenchmarkEndpoint_Input": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { "type": "string", - "nullable": true + "description": "The name of the benchmark." }, "description": { "type": "string", + "description": "Optional plain-text credit for the people or sources behind the benchmark. Limited to\n 2000 characters. Leave unset for no description.", "nullable": true }, - "type": { - "$ref": "#/components/schemas/ReplicateModelParameterType" - }, - "required": { - "type": "boolean" - }, - "default": {}, - "enumValues": { - "type": "array", - "items": { - "type": "string" - } + "initialBoostLevel": { + "type": "integer", + "description": "Initial boost level applied to the campaign of every run created from this benchmark.\n Leave unset to fall back to DefaultInitialBoostLevel. Admins\n may set any value the validator allows (0-10); non-admins are restricted to\n 0..BenchmarkEntity.DefaultInitialBoostLevel — anything outside that range returns\n 403 Forbidden via IsAllowedToSetInitialBoostLevel.", + "format": "int32", + "nullable": true }, - "minimum": { + "scoreShift": { "type": "number", + "description": "Additive offset applied to displayed scores on the overall scoreboard of this\n benchmark. Defaults to 0 when unset.", "format": "double", "nullable": true }, - "maximum": { + "scoreScale": { "type": "number", + "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on the overall scoreboard of this benchmark. Defaults to 1.0 when\n unset; must be strictly positive.", "format": "double", "nullable": true - }, - "order": { - "type": "integer", - "format": "int32", - "nullable": true } } }, - "GetSampleByIdEndpoint_Output": { + "CreateBenchmarkEndpoint_Output": { "required": [ - "id", - "identifier", - "participantId", - "participantName", - "asset", - "tags" + "id" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the sample." - }, - "identifier": { - "type": "string", - "description": "The identifier used to correlate samples of different participants." - }, - "participantId": { - "type": "string", - "description": "The id of the participant that owns the sample." - }, - "participantName": { + "description": "The id of the created benchmark." + } + } + }, + "CreateBenchmarkParticipantEndpoint_Input": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { "type": "string", - "description": "The name of the participant that owns the sample." - }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The asset associated with the sample." + "description": "The name of the participant." }, - "prompt": { + "family": { "type": "string", - "description": "An optional prompt associated with the sample.", - "nullable": true, - "deprecated": true + "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), if any.", + "nullable": true }, - "englishPrompt": { + "lab": { "type": "string", - "description": "An optional prompt text translated to English.", + "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"), if any.", "nullable": true }, - "originalPrompt": { + "proprietaryName": { "type": "string", - "description": "An optional prompt text as originally provided.", + "description": "The vendor-facing display name of the model, if any.", "nullable": true }, - "promptAsset": { - "allOf": [ + "licenseType": { + "type": "string", + "oneOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/ModelLicenseType" } ], - "description": "An optional prompt asset associated with the sample." + "description": "The license classification of the underlying model, if any.", + "nullable": true }, - "tags": { + "logo": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/ExistingAssetInput" } ], - "description": "The tags associated with the sample." - }, - "createdAt": { - "type": "string", - "description": "The timestamp when the sample was created.", - "format": "date-time" - }, - "ownerId": { - "type": "string", - "description": "The id of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", - "format": "uuid", - "nullable": true - }, - "ownerMail": { + "description": "An optional logo image for the model. Must be an existing image asset." + } + } + }, + "CreateBenchmarkParticipantEndpoint_Output": { + "required": [ + "participantId", + "datasetId" + ], + "type": "object", + "properties": { + "participantId": { "type": "string", - "description": "The mail of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", - "nullable": true + "description": "The id of the created participant." }, - "organizationId": { + "datasetId": { "type": "string", - "description": "The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.", - "nullable": true + "description": "The id of the participant's dataset." } } }, - "GetSampleGenerationEndpoint_Output": { + "CreateLeaderboardEndpoint_Input": { "required": [ - "id", - "benchmarkId", - "status", - "samplesPerPrompt", - "totalCount", - "completedCount", - "failedCount", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" + "name", + "instruction", + "showPrompt" ], "type": "object", "properties": { - "id": { + "benchmarkId": { "type": "string", - "description": "The id of the sample generation request." + "description": "If the leaderboard should be added to a preexisting benchmark, the benchmark id.", + "nullable": true }, - "benchmarkId": { + "benchmarkName": { "type": "string", - "description": "The benchmark this generation belongs to." + "description": "When no BenchmarkId is provided, the name of the new benchmark to create.", + "nullable": true }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/SampleGenerationStatus" - } - ], - "description": "The current status of the generation." + "benchmarkDescription": { + "type": "string", + "description": "Optional plain-text credit for the people or sources behind the benchmark, applied to\n the new benchmark created via BenchmarkName. Limited to 2000 characters.\n Ignored when an existing BenchmarkId is provided. Leave unset for no\n description.", + "nullable": true }, - "samplesPerPrompt": { + "name": { + "type": "string", + "description": "The name of the leaderboard." + }, + "instruction": { + "type": "string", + "description": "The instruction datapoints will be matched up against." + }, + "showPrompt": { + "type": "boolean", + "description": "Indicates if the prompt is shown on the rapids." + }, + "showPromptAsset": { + "type": "boolean", + "description": "Whether the prompt asset should be shown on the rapids." + }, + "responseBudget": { "type": "integer", - "description": "How many samples are being generated per prompt.", - "format": "int32" + "description": "Total amount of responses that get collected per run.", + "format": "int32", + "nullable": true }, - "totalCount": { + "minResponses": { "type": "integer", - "description": "The total number of items queued.", - "format": "int32" + "description": "The minimum amount of responses that need to be collected per comparison.", + "format": "int32", + "nullable": true }, - "completedCount": { + "isInversed": { + "type": "boolean", + "description": "Whether the results should be inversed, selecting the worse model." + }, + "audienceId": { + "type": "string", + "description": "Optional audience id; defaults to the global audience when unset.", + "nullable": true + }, + "priority": { "type": "integer", - "description": "The number of items that have succeeded so far.", + "description": "Optional priority override applied to every run's job. Admin-only.\n When unset, runs use the default leaderboard priority.", "format": "int32" }, - "failedCount": { - "type": "integer", - "description": "The number of items that have failed.", - "format": "int32" + "weight": { + "type": "number", + "description": "Multiplier applied to every match result of this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards. Defaults to 1.0 when\n unset; unbounded (negative and zero values are accepted).", + "format": "double" + }, + "scoreShift": { + "type": "number", + "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard. Defaults to 0 when unset.", + "format": "double" + }, + "scoreScale": { + "type": "number", + "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard. Defaults to 1.0 when\n unset; must be strictly positive.", + "format": "double" + }, + "isHidden": { + "type": "boolean", + "description": "Whether the leaderboard should be created hidden. Admin-only." + }, + "isExcludedFromOverall": { + "type": "boolean", + "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard.\n When set, the leaderboard becomes an owner-only private experiment: its results do not\n contribute to the overall and it is visible only to its owner and admins. Defaults to\n false when unset." }, - "participantIdFilter": { + "voteAggregation": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "$ref": "#/components/schemas/VoteAggregation" } ], - "description": "Optional participant id filter that was applied when this generation was created.", - "deprecated": true + "description": "How individual votes on a matchup are aggregated into the stored result. AllVotes\n counts every vote as a matchup; MajorityVote collapses each matchup to a single\n win for the majority side (ties split 0.5/0.5). Defaults to AllVotes when unset." }, - "participantFilter": { + "includedTags": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/GetSampleGenerationEndpoint_Output_Participant" - }, - "nullable": true + "type": "string" + } } ], - "description": "The participants (id + display name) this generation was filtered to when it was\n created, or null when no participant filter was applied. A since-deleted participant\n keeps its id with a null name." + "description": "Prompt tag values to restrict the leaderboard's matchups to. Only prompts carrying at\n least one of these tags are used; an empty list means no restriction." }, - "promptIdentifierFilter": { + "excludedTags": { "allOf": [ { "type": "array", "items": { "type": "string" - }, - "nullable": true + } } ], - "description": "Optional prompt identifier filter that was applied." + "description": "Prompt tag values the leaderboard never creates matchups for. Takes precedence over\n includedTags: a prompt carrying an excluded tag is skipped even when one of its\n other tags is included." }, - "tagsFilter": { + "featureFlags": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/FeatureFlag" }, "nullable": true } ], - "description": "Optional tag filter that was applied." + "description": "Feature flags applied to every order created by this leaderboard." }, - "ownerId": { + "skipInitialRun": { + "type": "boolean", + "description": "Set to true to skip the initial standings run. A newly added model is still\n compared against the whole existing field and boost runs still work — there is just no\n run collecting the first responses. On the benchmark's first leaderboard, participants\n that already have result images are submitted into the field so those paths have a field\n to work with; on a benchmark that already has a leaderboard they are in it already and\n are left untouched. Defaults to false, which queues the run as before." + } + } + }, + "CreateLeaderboardEndpoint_Output": { + "required": [ + "id", + "benchmarkId", + "showPrompt", + "showPromptAsset", + "responseBudget", + "minResponses", + "isInversed", + "voteAggregation" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "The id of the customer that started this generation.", - "format": "uuid" + "description": "The id of the created leaderboard." }, - "ownerMail": { + "benchmarkId": { "type": "string", - "description": "The mail of the customer that started this generation." + "description": "The id of the benchmark the leaderboard belongs to." }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." + "showPrompt": { + "type": "boolean", + "description": "Whether the prompt is shown on the rapids." }, - "createdAt": { - "type": "string", - "description": "When the generation was created.", - "format": "date-time" + "showPromptAsset": { + "type": "boolean", + "description": "Whether the prompt asset is shown on the rapids." + }, + "responseBudget": { + "type": "integer", + "description": "The response budget per run.", + "format": "int32" + }, + "minResponses": { + "type": "integer", + "description": "The minimum responses per comparison.", + "format": "int32" + }, + "isInversed": { + "type": "boolean", + "description": "Whether the leaderboard results are inversed." + }, + "voteAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/VoteAggregation" + } + ], + "description": "How individual votes on a matchup are aggregated into the stored result." } } }, - "GetSampleGenerationEndpoint_Output_Participant": { + "CreateLeaderboardParticipantEndpoint_Input": { "required": [ - "id" + "name" ], "type": "object", "properties": { - "id": { - "type": "string" - }, "name": { "type": "string", - "nullable": true + "description": "The name of the participant." } } }, - "GetSampleGenerationItemsEndpoint_Output": { + "CreateLeaderboardParticipantEndpoint_Output": { "required": [ - "id", - "sampleGenerationId", "participantId", - "benchmarkPromptId", - "promptIdentifier", - "sampleCount", - "status", - "attemptCount", - "sampleIds", - "createdAt" + "datasetId" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The id of the generation item." - }, - "sampleGenerationId": { - "type": "string", - "description": "The id of the parent sample generation." - }, "participantId": { "type": "string", - "description": "The participant whose faucet is producing this sample." + "description": "The id of the created participant." }, - "participantName": { + "datasetId": { "type": "string", - "description": "The participant's display name, or null if the participant no longer exists.", - "nullable": true - }, - "benchmarkPromptId": { + "description": "The id of the participant's dataset." + } + } + }, + "CreatePromptEmbeddingMapEndpoint_Output": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "The benchmark prompt this item targets." - }, - "promptIdentifier": { + "description": "The id of the queued prompt embedding map." + } + } + }, + "CreatePromptForBenchmarkEndpoint_Input": { + "required": [ + "identifier" + ], + "type": "object", + "properties": { + "identifier": { "type": "string", - "description": "The identifier of the prompt being generated." + "description": "An identifier associated with the prompt." }, - "sampleCount": { - "type": "integer", - "description": "How many samples this item produces for its (participant, prompt) pair.", - "format": "int32" + "prompt": { + "type": "string", + "description": "The prompt text.", + "nullable": true }, - "status": { + "promptAsset": { "allOf": [ { - "$ref": "#/components/schemas/SampleGenerationItemStatus" + "$ref": "#/components/schemas/IAssetInput" } ], - "description": "The current status of this item." - }, - "attemptCount": { - "type": "integer", - "description": "Number of delivery attempts that have been made on this item.", - "format": "int32" - }, - "providerRequestId": { - "type": "string", - "description": "Provider-side request id used to correlate with the provider's logs.", - "nullable": true - }, - "failureReason": { - "type": "string", - "description": "Failure reason if the item is in a failed state.", - "nullable": true + "description": "The asset associated with the prompt." }, - "sampleIds": { + "tags": { "allOf": [ { "type": "array", "items": { - "type": "string" - } + "$ref": "#/components/schemas/Tag" + }, + "nullable": true } ], - "description": "The ids of the samples created from this item once it succeeds." + "description": "The tags associated with the prompt." }, - "createdAt": { + "origin": { + "allOf": [ + { + "$ref": "#/components/schemas/Origin" + } + ], + "description": "Where the prompt came from." + } + } + }, + "CreatePromptForBenchmarkEndpoint_Output": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "When the item was created.", - "format": "date-time" + "description": "The id of the created prompt." } } }, - "GetSampleGenerationItemsEndpoint_PagedResultOfOutput": { + "CreatePromptForLeaderboardEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "items" + "id" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetSampleGenerationItemsEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" + "id": { + "type": "string", + "description": "The id of the created prompt." } } }, - "GetSampleNavigationEndpoint_Output": { + "CreateSampleEndpoint_Input": { "required": [ - "current", - "previous", - "next", - "related" + "identifier", + "asset" ], "type": "object", "properties": { - "current": { + "identifier": { + "type": "string", + "description": "The identifier used to correlate samples of different participants." + }, + "asset": { "allOf": [ { - "$ref": "#/components/schemas/GetSampleNavigationEndpoint_Sample" + "$ref": "#/components/schemas/IAssetInput" } ], - "description": "The current sample that navigation is anchored on." + "description": "The asset input for the sample." + } + } + }, + "CreateSampleEndpoint_Output": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the created sample." + } + } + }, + "CreateSampleGenerationEndpoint_Input": { + "required": [ + "samplesPerPrompt" + ], + "type": "object", + "properties": { + "samplesPerPrompt": { + "type": "integer", + "description": "How many samples to request per matching prompt (1 to 16).", + "format": "int32" }, - "previous": { + "participantIds": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/GetSampleNavigationEndpoint_Sample" - } + "type": "string" + }, + "nullable": true } ], - "description": "Up to three samples of the same participant preceding the current sample,\n ordered ascending by identifier. Empty when the current sample is the first\n of its participant." + "description": "Restrict generation to specific participants. Defaults to all participants\n in the benchmark that have a configured faucet." }, - "next": { + "promptIdentifiers": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/GetSampleNavigationEndpoint_Sample" - } + "type": "string" + }, + "nullable": true } ], - "description": "Up to three samples of the same participant following the current sample,\n ordered ascending by identifier. Empty when the current sample is the last\n of its participant." + "description": "Restrict generation to specific prompt identifiers.\n Defaults to every prompt in the benchmark." }, - "related": { + "tags": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/GetSampleNavigationEndpoint_Sample" - } + "type": "string" + }, + "nullable": true } ], - "description": "Samples of other participants in the same benchmark that share the current\n sample's identifier, ordered by participant name and capped at the requested\n related limit." + "description": "Restrict generation to prompts having at least one of these tags." } } }, - "GetSampleNavigationEndpoint_Sample": { + "CreateSampleGenerationEndpoint_Output": { "required": [ "id", - "identifier", - "participantId", - "participantName", - "asset", - "tags" + "totalCount", + "skippedParticipantIds" ], "type": "object", "properties": { "id": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "participantId": { - "type": "string" - }, - "participantName": { - "type": "string" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "prompt": { - "type": "string", - "nullable": true, - "deprecated": true - }, - "englishPrompt": { "type": "string", - "nullable": true + "description": "The id of the created sample generation request." }, - "originalPrompt": { - "type": "string", - "nullable": true + "totalCount": { + "type": "integer", + "description": "The total number of generation items that were queued.", + "format": "int32" }, - "promptAsset": { - "type": "object", - "oneOf": [ + "skippedParticipantIds": { + "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "type": "array", + "items": { + "type": "string" + } } ], - "nullable": true - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "ownerId": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "ownerMail": { - "type": "string", - "nullable": true - }, - "organizationId": { - "type": "string", - "nullable": true + "description": "Participants that matched the selection but were skipped because they have no faucet\n configured. Empty when explicit participant ids were supplied." } } }, - "GetSamplesByIdentifierEndpoint_Output": { + "CreateSampleNewEndpoint_Input": { "required": [ - "id", "identifier", - "participantId", - "participantName", - "asset", - "tags" + "asset" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the sample." - }, "identifier": { "type": "string", "description": "The identifier used to correlate samples of different participants." }, - "participantId": { - "type": "string", - "description": "The id of the participant that owns the sample." - }, - "participantName": { - "type": "string", - "description": "The name of the participant that owns the sample." - }, "asset": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/IAssetInput" } ], - "description": "The asset associated with the sample." - }, - "prompt": { + "description": "The asset input for the sample." + } + } + }, + "CreateSampleNewEndpoint_Output": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { "type": "string", - "description": "An optional prompt associated with the sample.", - "nullable": true, - "deprecated": true + "description": "The id of the created sample." + } + } + }, + "ForkBenchmarkEndpoint_Output": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the new benchmark created." + } + } + }, + "GetBenchmarkByIdEndpoint_Output": { + "required": [ + "id", + "name", + "description", + "isPublic", + "isPublished", + "createdAt", + "initialBoostLevel", + "scoreShift", + "scoreScale", + "lastUpdatedAt" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the benchmark." }, - "englishPrompt": { + "name": { "type": "string", - "description": "An optional prompt text translated to English.", - "nullable": true + "description": "The name of the benchmark." }, - "originalPrompt": { + "description": { "type": "string", - "description": "An optional prompt text as originally provided.", + "description": "Optional plain-text credit for the people or sources behind the benchmark. Null when no\n description was supplied.", "nullable": true }, - "promptAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "An optional prompt asset associated with the sample." + "isPublic": { + "type": "boolean", + "description": "Whether the benchmark is public." }, - "tags": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The tags associated with the sample." + "isPublished": { + "type": "boolean", + "description": "Whether the benchmark is published to the public benchmark repository." }, "createdAt": { "type": "string", - "description": "The timestamp when the sample was created.", + "description": "The timestamp when the benchmark was created.", "format": "date-time" }, "ownerId": { "type": "string", - "description": "The id of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", + "description": "The id of the customer owning the benchmark. Null unless the caller is platform staff or a member of the owning organization.", "format": "uuid", "nullable": true }, "ownerMail": { "type": "string", - "description": "The mail of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", + "description": "The mail of the customer owning the benchmark. Null unless the caller is platform staff or a member of the owning organization.", "nullable": true }, "organizationId": { "type": "string", "description": "The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.", "nullable": true + }, + "initialBoostLevel": { + "type": "integer", + "description": "The initial boost level applied to the campaign of every run created from this\n benchmark. Null means the benchmark default is used.", + "format": "int32", + "nullable": true + }, + "scoreShift": { + "type": "number", + "description": "Additive offset applied to displayed scores on the overall scoreboard of this\n benchmark.", + "format": "double" + }, + "scoreScale": { + "type": "number", + "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on the overall scoreboard of this benchmark.", + "format": "double" + }, + "lastUpdatedAt": { + "type": "string", + "description": "When the benchmark's rankings last changed: the latest vote recording across the\n leaderboards contributing to its overall. Null when none of them ever received votes.", + "format": "date-time", + "nullable": true } } }, - "GetSamplesByIdentifierEndpoint_PagedResultOfOutput": { + "GetBenchmarkDemographicsEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "items" + "totalVotes", + "dimensions" ], "type": "object", "properties": { - "total": { + "totalVotes": { "type": "integer", + "description": "The total votes behind the composition.", "format": "int64" }, - "page": { - "type": "integer", - "format": "int32" + "dimensions": { + "allOf": [ + { + "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_DimensionSet" + } + ], + "description": "The per-dimension bucket breakdowns." + } + }, + "description": "The demographic composition of a benchmark's votes." + }, + "GetBenchmarkDemographicsEndpoint_Output_Bucket": { + "required": [ + "value", + "votes", + "share" + ], + "type": "object", + "properties": { + "value": { + "type": "string" }, - "pageSize": { + "votes": { "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetSamplesByIdentifierEndpoint_Output" - } + "format": "int64" }, - "totalPages": { - "type": "integer", - "format": "int32" + "share": { + "type": "number", + "format": "double" } } }, - "GetSamplesByParticipantEndpoint_ISampleOutput": { + "GetBenchmarkDemographicsEndpoint_Output_DimensionSet": { "required": [ - "_t" + "ageBucket", + "gender", + "occupation", + "country", + "language" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput" + "properties": { + "ageBucket": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" + } }, - { - "$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput" - } - ], - "description": "Represents a sample returned for a participant.", - "discriminator": { - "propertyName": "_t", - "mapping": { - "SampleOutput": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput", - "PlaceholderSampleOutput": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput" + "gender": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" + } + }, + "occupation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" + } + }, + "country": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" + } + }, + "language": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBenchmarkDemographicsEndpoint_Output_Bucket" + } } } }, - "GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput": { + "GetBenchmarkHuggingFaceSyncEndpoint_Output": { "required": [ - "identifier", - "tags", - "_t" + "status" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "PlaceholderSampleOutput" + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/HuggingFaceSyncStatus" + } ], - "type": "string" + "description": "Current lifecycle status (NeverSynced when the benchmark has never been synced)." }, - "identifier": { + "outcome": { "type": "string", - "description": "The identifier used to correlate samples of different participants." + "oneOf": [ + { + "$ref": "#/components/schemas/HuggingFaceSyncOutcome" + } + ], + "description": "Outcome of the last completed attempt, or null when none has completed.", + "nullable": true }, - "prompt": { + "repoId": { "type": "string", - "description": "An optional prompt associated with the sample.", - "nullable": true, - "deprecated": true + "description": "The target HuggingFace repo id (e.g. Rapidata/svg-benchmark), or null.", + "nullable": true }, - "englishPrompt": { + "repoUrl": { "type": "string", - "description": "An optional prompt text translated to English.", + "description": "URL of the HuggingFace repo, or null when not yet known.", "nullable": true }, - "originalPrompt": { + "prUrl": { "type": "string", - "description": "An optional prompt text as originally provided.", + "description": "URL of the review pull request opened by the last attempt, or null.", "nullable": true }, - "promptAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "An optional prompt asset associated with the sample." + "lastSyncedAt": { + "type": "string", + "description": "When the benchmark was last successfully synced, or null.", + "format": "date-time", + "nullable": true }, - "tags": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The tags associated with the sample." + "lastError": { + "type": "string", + "description": "The error from the last failed attempt, or null.", + "nullable": true } } }, - "GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput": { + "GetBenchmarkHuggingFaceSyncHistoryEndpoint_Output": { "required": [ "id", - "identifier", - "asset", - "tags", - "_t" + "status", + "repoId", + "triggeredBy", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "SampleOutput" - ], - "type": "string" - }, "id": { "type": "string", - "description": "The unique identifier of the sample." - }, - "identifier": { - "type": "string", - "description": "The identifier used to correlate samples of different participants." + "description": "The attempt id (also the correlation token for its export/sync jobs)." }, - "asset": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/HuggingFaceSyncStatus" } ], - "description": "The asset associated with the sample." + "description": "Lifecycle status of the attempt." }, - "prompt": { + "outcome": { "type": "string", - "description": "An optional prompt associated with the sample.", - "nullable": true, - "deprecated": true + "oneOf": [ + { + "$ref": "#/components/schemas/HuggingFaceSyncOutcome" + } + ], + "description": "Outcome once completed, or null while still running or on failure.", + "nullable": true }, - "englishPrompt": { + "repoId": { "type": "string", - "description": "An optional prompt text translated to English.", - "nullable": true + "description": "The HuggingFace repo this attempt targeted." }, - "originalPrompt": { + "repoUrl": { "type": "string", - "description": "An optional prompt text as originally provided.", + "description": "URL of the HuggingFace repo, or null when not yet known.", "nullable": true }, - "promptAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "An optional prompt asset associated with the sample." - }, - "tags": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The tags associated with the sample." - }, - "createdAt": { + "prUrl": { "type": "string", - "description": "The timestamp when the sample was created.", - "format": "date-time" + "description": "URL of the review pull request opened by the attempt, or null.", + "nullable": true }, - "ownerId": { + "error": { "type": "string", - "description": "The id of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", - "format": "uuid", + "description": "The error from a failed attempt, or null.", "nullable": true }, - "ownerMail": { + "triggeredBy": { "type": "string", - "description": "The mail of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", + "description": "Provenance of the trigger (an admin's mail, or auto-sync)." + }, + "syncedRowCount": { + "type": "integer", + "description": "Rows the worker synced, or null until it reports success.", + "format": "int64", "nullable": true }, - "organizationId": { + "createdAt": { "type": "string", - "description": "The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.", + "description": "When the attempt was started.", + "format": "date-time" + }, + "completedAt": { + "type": "string", + "description": "When the attempt reached a terminal state, or null while still running.", + "format": "date-time", "nullable": true } } }, - "GetSamplesByParticipantEndpoint_PagedResultOfISampleOutput": { + "GetBenchmarkHuggingFaceSyncHistoryEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -54161,7 +50755,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutput" + "$ref": "#/components/schemas/GetBenchmarkHuggingFaceSyncHistoryEndpoint_Output" } }, "totalPages": { @@ -54170,240 +50764,79 @@ } } }, - "HuggingFaceSyncOutcome": { - "enum": [ - "CreatedPrivate", - "UpdatedPrivate", - "OpenedPullRequest", - "Failed", - null - ] - }, - "HuggingFaceSyncStatus": { - "enum": [ - "NeverSynced", - "Exporting", - "Uploading", - "Completed", - "Failed" - ] - }, - "IFaucetInput": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IFaucetInputReplicateFaucetInput" - } - ], - "description": "Polymorphic request body describing a faucet to configure on a participant. The concrete\n type is selected by the _t discriminator (e.g. \"Replicate\").", - "discriminator": { - "propertyName": "_t", - "mapping": { - "Replicate": "#/components/schemas/IFaucetInputReplicateFaucetInput" - } - } - }, - "IFaucetInputReplicateFaucetInput": { - "required": [ - "modelOwner", - "modelName", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "Replicate" - ], - "type": "string" - }, - "modelOwner": { - "type": "string", - "description": "The owner of the hosted model (e.g. \"stability-ai\")." - }, - "modelName": { - "type": "string", - "description": "The model name (e.g. \"sdxl\")." - }, - "modelVersion": { - "type": "string", - "description": "Optional pinned model version hash.", - "nullable": true - }, - "additionalInputs": { - "type": "object", - "description": "Extra model inputs keyed by parameter name (e.g. \"aspect_ratio\"). The system-managed keys\n (prompt, num_outputs) must not appear here — they are supplied automatically. Values are\n validated against the model's live input schema when the faucet is set." - } - }, - "description": "Configures a faucet that generates samples via the Replicate API." - }, - "IFaucetOutput": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IFaucetOutputManagedFaucetOutput" - }, - { - "$ref": "#/components/schemas/IFaucetOutputReplicateFaucetOutput" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "Managed": "#/components/schemas/IFaucetOutputManagedFaucetOutput", - "Replicate": "#/components/schemas/IFaucetOutputReplicateFaucetOutput" - } - } - }, - "IFaucetOutputManagedFaucetOutput": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "Managed" - ], - "type": "string" - }, - "testTimeScaling": { - "type": "integer", - "format": "int32", - "nullable": true - } - } - }, - "IFaucetOutputReplicateFaucetOutput": { - "required": [ - "modelOwner", - "modelName", - "additionalInputs", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "Replicate" - ], - "type": "string" - }, - "modelOwner": { - "type": "string" - }, - "modelName": { - "type": "string" - }, - "modelVersion": { - "type": "string", - "nullable": true - }, - "additionalInputs": { - "type": "object" - } - } - }, - "MatchupZone": { - "enum": [ - "AClearlyWins", - "CoinFlip", - "BClearlyWins", - null - ] - }, - "ModelLicenseType": { - "enum": [ - "OpenSource", - "Proprietary", - null - ] - }, - "Origin": { - "required": [ - "source" - ], - "type": "object", - "properties": { - "source": { - "type": "string" - } - } - }, - "ParticipantStatus": { - "enum": [ - "Created", - "Submittable", - "Submitted", - "Disabled" - ] - }, - "PromptEmbeddingMapStatus": { - "enum": [ - "Pending", - "Ready", - "Failed" - ] - }, - "QueryBenchmarksEndpoint_Output": { + "GetBenchmarkMatchupBreakdownEndpoint_Output": { "required": [ - "id", - "name", - "isManaged", - "isPublic", - "isPublished", - "createdAt", - "ownerMail", - "organizationId", - "lastUpdatedAt" + "promptIdentifier", + "rawWinsA", + "rawWinsB", + "weightedWinsA", + "weightedWinsB", + "effectiveN", + "wilsonCenter" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the benchmark." - }, - "name": { - "type": "string", - "description": "The name of the benchmark." - }, - "isManaged": { - "type": "boolean", - "description": "Whether the benchmark is managed." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the benchmark is public." - }, - "isPublished": { - "type": "boolean", - "description": "Whether the benchmark is published to the public benchmark repository." - }, - "createdAt": { + "promptId": { "type": "string", - "description": "The timestamp when the benchmark was created.", - "format": "date-time" + "description": "The prompt entity id, or null when the identifier has no live prompt.", + "nullable": true }, - "ownerMail": { + "promptIdentifier": { "type": "string", - "description": "The mail of the customer owning the benchmark." + "description": "The stable identifier of the prompt within the benchmark." }, - "organizationId": { + "englishPrompt": { "type": "string", - "description": "The id of the organization that owns the entity." + "description": "The prompt text translated to English, if any.", + "nullable": true }, - "lastUpdatedAt": { + "originalPrompt": { "type": "string", - "description": "When the benchmark's rankings last changed: the latest vote recording across the\n leaderboards contributing to its overall. Null when none of them ever received votes.", - "format": "date-time", + "description": "The prompt text as originally provided, if any.", "nullable": true + }, + "promptAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The optional media asset shown with the prompt." + }, + "rawWinsA": { + "type": "integer", + "description": "The number of votes A won on this prompt.", + "format": "int64" + }, + "rawWinsB": { + "type": "integer", + "description": "The number of votes B won on this prompt.", + "format": "int64" + }, + "weightedWinsA": { + "type": "number", + "description": "The reliability-weighted wins for A (summed annotator userScore).", + "format": "double" + }, + "weightedWinsB": { + "type": "number", + "description": "The reliability-weighted wins for B (summed annotator userScore).", + "format": "double" + }, + "effectiveN": { + "type": "number", + "description": "The reliability-weighted sample size, WeightedWinsA + WeightedWinsB.", + "format": "double" + }, + "wilsonCenter": { + "type": "number", + "description": "The Wilson score interval center for A's win share.", + "format": "double" } - } + }, + "description": "One prompt's A-vs-B split with its render fields and vote stats." }, - "QueryBenchmarksEndpoint_PagedResultOfOutput": { + "GetBenchmarkMatchupBreakdownEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -54427,7 +50860,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryBenchmarksEndpoint_Output" + "$ref": "#/components/schemas/GetBenchmarkMatchupBreakdownEndpoint_Output" } }, "totalPages": { @@ -54436,11 +50869,51 @@ } } }, - "QueryBenchmarkStandingsEndpoint_Output": { + "GetBenchmarkStandingsBreakdownEndpoint_Output": { + "required": [ + "dimension", + "global", + "segments" + ], + "type": "object", + "properties": { + "dimension": { + "allOf": [ + { + "$ref": "#/components/schemas/BenchmarkDemographicDimension" + } + ], + "description": "The dimension the standings are split by." + }, + "global": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBenchmarkStandingsBreakdownEndpoint_Output_OutputItem" + } + } + ], + "description": "The standings over the whole filtered set, ordered by score descending." + }, + "segments": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBenchmarkStandingsBreakdownEndpoint_Output_Segment" + } + } + ], + "description": "The standings per dimension value, ordered by votes descending with unknown last." + } + }, + "description": "The standings broken down by a demographic dimension." + }, + "GetBenchmarkStandingsBreakdownEndpoint_Output_OutputItem": { "required": [ "id", "name", - "benchmarkId", "status", "score", "wins", @@ -54450,26 +50923,21 @@ "type": "object", "properties": { "id": { - "type": "string", - "description": "The unique identifier of the participant." + "type": "string" }, "name": { - "type": "string", - "description": "The name of the participant." + "type": "string" }, "family": { "type": "string", - "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), or null if unset.", "nullable": true }, "lab": { "type": "string", - "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"), or null if unset.", "nullable": true }, "proprietaryName": { "type": "string", - "description": "The vendor-facing display name of the model, or null if unset.", "nullable": true }, "licenseType": { @@ -54479,210 +50947,104 @@ "$ref": "#/components/schemas/ModelLicenseType" } ], - "description": "The license classification of the underlying model, or null if not classified yet.", "nullable": true }, "logo": { "type": "string", - "description": "The logo of the model, or null if unset.", "nullable": true }, - "benchmarkId": { - "type": "string", - "description": "The id of the benchmark this standing belongs to." - }, "status": { - "allOf": [ - { - "$ref": "#/components/schemas/StandingStatus" - } - ], - "description": "The status of the standing." + "$ref": "#/components/schemas/StandingStatus" }, "score": { "type": "number", - "description": "The calculated score, or null if not yet computed.", "format": "double", "nullable": true }, "wins": { "type": "number", - "description": "The number of wins.", "format": "double" }, "totalMatches": { "type": "number", - "description": "The total number of matches.", "format": "double" }, "isDisabled": { - "type": "boolean", - "description": "Whether the participant is disabled." + "type": "boolean" }, "confidenceInterval": { - "allOf": [ + "type": "object", + "oneOf": [ { "$ref": "#/components/schemas/ConfidenceInterval" } ], - "description": "The confidence interval bounds, if requested." + "nullable": true } } }, - "QueryBenchmarkStandingsEndpoint_PagedResultOfOutput": { + "GetBenchmarkStandingsBreakdownEndpoint_Output_Segment": { "required": [ - "total", - "page", - "pageSize", + "value", + "votes", "items" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" + "value": { + "type": "string" }, - "pageSize": { + "votes": { "type": "integer", - "format": "int32" + "format": "int64" }, "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryBenchmarkStandingsEndpoint_Output" + "$ref": "#/components/schemas/GetBenchmarkStandingsBreakdownEndpoint_Output_OutputItem" } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "QueryCombinedMatrixByBenchmarksEndpoint_Output": { - "required": [ - "index", - "columns", - "data" - ], - "type": "object", - "properties": { - "index": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The participant names of the matrix rows, ordered strongest first." - }, - "columns": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The participant names of the matrix columns, ordered strongest first." - }, - "data": { - "allOf": [ - { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - } - ], - "description": "The win counts; Data[i][j] holds the wins of Index[i] over Columns[j]." } } }, - "QueryCombinedMatrixByLeaderboardsEndpoint_Output": { + "GetBenchmarkStandingsByTagEndpoint_Output": { "required": [ - "index", - "columns", - "data" + "global", + "totalResponses", + "segments" ], "type": "object", "properties": { - "index": { + "global": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GetBenchmarkStandingsByTagEndpoint_Output_OutputItem" } } ], - "description": "The participant names of the matrix rows, ordered strongest first." + "description": "The standings over the whole filtered set, ordered by score descending." }, - "columns": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The participant names of the matrix columns, ordered strongest first." + "totalResponses": { + "type": "integer", + "description": "Total raw human responses (votes) behind Global under the current filter —\n the actual response count, not the per-participant TotalMatches (which counts\n binarized matchups, so a comparison's several votes collapse into one).", + "format": "int64" }, - "data": { - "allOf": [ - { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - } - ], - "description": "The win counts; Data[i][j] holds the wins of Index[i] over Columns[j]." - } - } - }, - "QueryCombinedStandingsByBenchmarksEndpoint_Output": { - "required": [ - "items", - "totalResponses" - ], - "type": "object", - "properties": { - "items": { + "segments": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/QueryCombinedStandingsByBenchmarksEndpoint_OutputItem" + "$ref": "#/components/schemas/GetBenchmarkStandingsByTagEndpoint_Output_Segment" } } ], - "description": "The standings items, ordered by score descending." - }, - "totalResponses": { - "type": "integer", - "description": "Total raw human responses (votes) behind these standings under the current filter — the\n actual response count, not the per-participant TotalMatches (which counts\n binarized matchups, so a comparison's several votes collapse into one).", - "format": "int64" + "description": "The standings per tag, ordered by votes descending." } }, - "description": "The queried standings output." + "description": "The standings sliced by prompt tag." }, - "QueryCombinedStandingsByBenchmarksEndpoint_OutputItem": { + "GetBenchmarkStandingsByTagEndpoint_Output_OutputItem": { "required": [ "id", "name", @@ -54691,6 +51053,7 @@ "wins", "totalMatches", "responseCount", + "isEvaluating", "isDisabled" ], "type": "object", @@ -54746,6 +51109,9 @@ "type": "integer", "format": "int64" }, + "isEvaluating": { + "type": "boolean" + }, "isDisabled": { "type": "boolean" }, @@ -54760,33 +51126,152 @@ } } }, - "QueryCombinedStandingsByLeaderboardsEndpoint_Output": { + "GetBenchmarkStandingsByTagEndpoint_Output_Segment": { "required": [ - "items", - "totalResponses" + "value", + "promptCount", + "votes", + "items" ], "type": "object", "properties": { + "value": { + "type": "string" + }, + "axis": { + "type": "string", + "nullable": true + }, + "promptCount": { + "type": "integer", + "format": "int32" + }, + "votes": { + "type": "integer", + "format": "int64" + }, "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBenchmarkStandingsByTagEndpoint_Output_SegmentItem" + } + } + } + }, + "GetBenchmarkStandingsByTagEndpoint_Output_SegmentItem": { + "required": [ + "id", + "score", + "wins", + "totalMatches", + "responseCount", + "isDisabled" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "score": { + "type": "number", + "format": "double", + "nullable": true + }, + "wins": { + "type": "number", + "format": "double" + }, + "totalMatches": { + "type": "number", + "format": "double" + }, + "responseCount": { + "type": "integer", + "format": "int64" + }, + "isDisabled": { + "type": "boolean" + }, + "confidenceInterval": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ConfidenceInterval" + } + ], + "nullable": true + } + } + }, + "GetCombinedBenchmarkMatrixEndpoint_Output": { + "required": [ + "index", + "columns", + "data" + ], + "type": "object", + "properties": { + "index": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/QueryCombinedStandingsByLeaderboardsEndpoint_OutputItem" + "type": "string" } } ], - "description": "The standings items, ordered by score descending." + "description": "Row participant names." }, - "totalResponses": { - "type": "integer", - "description": "Total raw human responses (votes) behind these standings under the current filter — the\n actual response count, not the per-participant TotalMatches (which counts\n binarized matchups, so a comparison's several votes collapse into one).", - "format": "int64" + "columns": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Column participant names." + }, + "data": { + "allOf": [ + { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } + ], + "description": "NxN matrix where Data[i][j] = wins of Index[i] over Columns[j]." } }, - "description": "The queried standings output." + "description": "Combined benchmark matrix output in pandas split format." }, - "QueryCombinedStandingsByLeaderboardsEndpoint_OutputItem": { + "GetCombinedBenchmarkStandingsEndpoint_Output": { + "required": [ + "items" + ], + "type": "object", + "properties": { + "items": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetCombinedBenchmarkStandingsEndpoint_OutputItem" + } + } + ], + "description": "The standings items." + } + }, + "description": "Combined benchmark standings output." + }, + "GetCombinedBenchmarkStandingsEndpoint_OutputItem": { "required": [ "id", "name", @@ -54794,7 +51279,6 @@ "score", "wins", "totalMatches", - "responseCount", "isDisabled" ], "type": "object", @@ -54846,10 +51330,6 @@ "type": "number", "format": "double" }, - "responseCount": { - "type": "integer", - "format": "int64" - }, "isDisabled": { "type": "boolean" }, @@ -54864,99 +51344,123 @@ } } }, - "QueryLeaderboardRunsEndpoint_Output": { + "GetCombinedLeaderboardMatrixEndpoint_Output": { "required": [ - "id", - "name", - "status", - "createdAt", - "ownerMail", - "organizationId", - "orderId", - "jobId", - "audienceId" + "index", + "columns", + "data" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the run." - }, - "name": { - "type": "string", - "description": "The name of the run." - }, - "status": { + "index": { "allOf": [ { - "$ref": "#/components/schemas/RunStatus" + "type": "array", + "items": { + "type": "string" + } } ], - "description": "The status of the run." - }, - "createdAt": { - "type": "string", - "description": "The timestamp when the run was created.", - "format": "date-time" - }, - "ownerMail": { - "type": "string", - "description": "The mail of the owner of the run." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - }, - "orderId": { - "type": "string", - "description": "The id of the associated order, if any.", - "nullable": true + "description": "Row participant names." }, - "jobId": { - "type": "string", - "description": "The id of the associated job, if any.", - "nullable": true + "columns": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Column participant names." }, - "audienceId": { - "type": "string", - "description": "The id of the audience associated with the run." + "data": { + "allOf": [ + { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } + ], + "description": "NxN matrix where Data[i][j] = wins of Index[i] over Columns[j]." } - } + }, + "description": "Combined leaderboard matrix output in pandas split format." }, - "QueryLeaderboardRunsEndpoint_PagedResultOfOutput": { + "GetCombinedLeaderboardStandingsEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", "items" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" + "items": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetCombinedLeaderboardStandingsEndpoint_OutputItem" + } + } + ], + "description": "The standings items." + } + }, + "description": "Combined leaderboard standings output." + }, + "GetCombinedLeaderboardStandingsEndpoint_OutputItem": { + "required": [ + "id", + "name", + "status", + "score", + "wins", + "totalMatches", + "isDisabled" + ], + "type": "object", + "properties": { + "id": { + "type": "string" }, - "page": { - "type": "integer", - "format": "int32" + "name": { + "type": "string" }, - "pageSize": { - "type": "integer", - "format": "int32" + "status": { + "$ref": "#/components/schemas/StandingStatus" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryLeaderboardRunsEndpoint_Output" - } + "score": { + "type": "number", + "format": "double", + "nullable": true }, - "totalPages": { - "type": "integer", - "format": "int32" + "wins": { + "type": "number", + "format": "double" + }, + "totalMatches": { + "type": "number", + "format": "double" + }, + "isDisabled": { + "type": "boolean" + }, + "confidenceInterval": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ConfidenceInterval" + } + ], + "nullable": true } } }, - "QueryLeaderboardsByBenchmarkEndpoint_Output": { + "GetLeaderboardByIdEndpoint_Output": { "required": [ "id", "name", @@ -54973,6 +51477,7 @@ "scoreScale", "isHidden", "isExcludedFromOverall", + "voteAggregation", "includedTags", "excludedTags", "lastUpdatedAt" @@ -54989,37 +51494,43 @@ }, "instruction": { "type": "string", - "description": "The instruction shown on the leaderboard." + "description": "The instruction used when collecting responses." }, "showPrompt": { "type": "boolean", - "description": "Whether the prompt text is shown." + "description": "Whether the prompt is shown on the rapids." }, "showPromptAsset": { "type": "boolean", - "description": "Whether the prompt asset is shown." + "description": "Whether the prompt asset is shown on the rapids." }, "isInversed": { "type": "boolean", - "description": "Whether the leaderboard's scoring is inversed." + "description": "Whether the leaderboard results are inversed." }, "responseBudget": { "type": "integer", - "description": "The response budget for the leaderboard.", + "description": "The response budget per run.", "format": "int32" }, "minResponses": { "type": "integer", - "description": "The minimum number of responses for the leaderboard.", + "description": "The minimum responses collected per comparison.", "format": "int32" }, "audienceId": { "type": "string", - "description": "The id of the audience assigned to the leaderboard." + "description": "The id of the audience that evaluates the leaderboard." }, "jobDefinitionId": { "type": "string", - "description": "The id of the job definition assigned to the leaderboard, if any.", + "description": "The id of the associated job definition, if any.", + "nullable": true + }, + "priority": { + "type": "integer", + "description": "Priority override applied to every run's job. Null when no override is set; runs then\n fall back to the default leaderboard priority.", + "format": "int32", "nullable": true }, "featureFlags": { @@ -55031,7 +51542,7 @@ } } ], - "description": "The feature flags enabled for the leaderboard." + "description": "Feature flags applied to orders created from this leaderboard." }, "weight": { "type": "number", @@ -55054,7 +51565,15 @@ }, "isExcludedFromOverall": { "type": "boolean", - "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard,\n making it a private experiment of the owning organization." + "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard,\n making it an owner-only private experiment." + }, + "voteAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/VoteAggregation" + } + ], + "description": "How individual votes on a matchup are aggregated into the stored result." }, "includedTags": { "allOf": [ @@ -55086,179 +51605,261 @@ } } }, - "QueryLeaderboardsByBenchmarkEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryLeaderboardsByBenchmarkEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "QueryLeaderboardsEndpoint_Output": { + "GetParticipantByIdEndpoint_Output": { "required": [ "id", "name", - "instruction", - "showPrompt", - "showPromptAsset", - "isInversed", - "responseBudget", - "minResponses", - "audienceId", - "featureFlags", - "weight", - "scoreShift", - "scoreScale", - "isHidden", - "isExcludedFromOverall", - "voteAggregation", - "includedTags", - "excludedTags", - "lastUpdatedAt" + "benchmarkId", + "status" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the leaderboard." + "description": "The unique identifier of the participant." }, "name": { "type": "string", - "description": "The name of the leaderboard." + "description": "The name of the participant." }, - "instruction": { + "benchmarkId": { "type": "string", - "description": "The instruction used when collecting responses." - }, - "showPrompt": { - "type": "boolean", - "description": "Whether the prompt is shown on the rapids." + "description": "The id of the benchmark the participant belongs to." }, - "showPromptAsset": { - "type": "boolean", - "description": "Whether the prompt asset is shown on the rapids." + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ParticipantStatus" + } + ], + "description": "The status of the participant." }, - "isInversed": { - "type": "boolean", - "description": "Whether the leaderboard results are inversed." + "family": { + "type": "string", + "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), or null if unset.", + "nullable": true }, - "responseBudget": { - "type": "integer", - "description": "The response budget per run.", - "format": "int32" + "lab": { + "type": "string", + "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"), or null if unset.", + "nullable": true }, - "minResponses": { - "type": "integer", - "description": "The minimum responses collected per comparison.", - "format": "int32" + "proprietaryName": { + "type": "string", + "description": "The vendor-facing display name of the model, or null if unset.", + "nullable": true }, - "audienceId": { + "licenseType": { "type": "string", - "description": "The id of the audience that evaluates the leaderboard." + "oneOf": [ + { + "$ref": "#/components/schemas/ModelLicenseType" + } + ], + "description": "The license classification of the underlying model, or null if not classified yet.", + "nullable": true }, - "jobDefinitionId": { + "logo": { "type": "string", - "description": "The id of the associated job definition, if any.", + "description": "The logo of the model, or null if unset.", "nullable": true }, - "featureFlags": { + "faucet": { + "allOf": [ + { + "$ref": "#/components/schemas/IFaucetOutput" + } + ], + "description": "The faucet configured to auto-generate samples, or null if none is set." + } + } + }, + "GetPromptEmbeddingMapEndpoint_Output": { + "required": [ + "computedAt", + "promptCount", + "tags", + "points" + ], + "type": "object", + "properties": { + "computedAt": { + "type": "string", + "description": "When the map finished computing.", + "format": "date-time" + }, + "promptCount": { + "type": "integer", + "description": "How many prompts the map contains. Prompts without English text are not embedded, so this\n can be lower than the benchmark's prompt total.", + "format": "int32" + }, + "tags": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/Tag" } } ], - "description": "Feature flags applied to orders created from this leaderboard." + "description": "The de-duplicated tag vocabulary for the map. Each point's tagIndices are positions\n in this list." }, - "weight": { - "type": "number", - "description": "Multiplier applied to every match result from this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards.", - "format": "double" + "points": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetPromptEmbeddingMapEndpoint_Output_Point" + } + } + ], + "description": "One point per embedded prompt." + } + } + }, + "GetPromptEmbeddingMapEndpoint_Output_Point": { + "required": [ + "promptId", + "x", + "y", + "tagIndices" + ], + "type": "object", + "properties": { + "promptId": { + "type": "string" }, - "scoreShift": { + "x": { "type": "number", - "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", "format": "double" }, - "scoreScale": { + "y": { "type": "number", - "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard.", "format": "double" }, - "isHidden": { - "type": "boolean", - "description": "Whether the leaderboard is hidden in listings and reads for non-admins." + "source": { + "type": "string", + "nullable": true }, - "isExcludedFromOverall": { - "type": "boolean", - "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard,\n making it a private experiment of the owning organization." + "prompt": { + "type": "string", + "nullable": true }, - "voteAggregation": { + "tagIndices": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + } + } + }, + "GetPromptEmbeddingMapStatusEndpoint_Output": { + "required": [ + "id", + "status", + "promptCount" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the benchmark's map." + }, + "status": { "allOf": [ { - "$ref": "#/components/schemas/VoteAggregation" + "$ref": "#/components/schemas/PromptEmbeddingMapStatus" } ], - "description": "How individual votes on a matchup are aggregated into the stored result." + "description": "The state of the most recent computation — not of the map being served. A Pending or\n Failed status still leaves the previously computed map on the public route." }, - "includedTags": { + "promptCount": { + "type": "integer", + "description": "How many prompts the map contains. Prompts without English text are not embedded, so this\n can be lower than the benchmark's prompt total. Zero until the first run succeeds.", + "format": "int32" + }, + "computedAt": { + "type": "string", + "description": "When the points currently being served were computed. Absent until the first run succeeds.", + "format": "date-time", + "nullable": true + }, + "failureReason": { + "type": "string", + "description": "Why the computation failed, when it did.", + "nullable": true + } + } + }, + "GetPromptsByBenchmarkEndpoint_Output": { + "required": [ + "id", + "identifier", + "createdAt", + "tags" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the prompt." + }, + "prompt": { + "type": "string", + "description": "The prompt text.", + "nullable": true, + "deprecated": true + }, + "englishPrompt": { + "type": "string", + "description": "The prompt text translated to English.", + "nullable": true + }, + "originalPrompt": { + "type": "string", + "description": "The prompt text as originally provided.", + "nullable": true + }, + "promptAsset": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/IAsset" } ], - "description": "Prompt tag values the leaderboard restricts its matchups to. Empty means no restriction." + "description": "The optional asset associated with the prompt." }, - "excludedTags": { + "identifier": { + "type": "string", + "description": "The identifier associated with the prompt." + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the prompt was created.", + "format": "date-time" + }, + "tags": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/Tag" } } ], - "description": "Prompt tag values the leaderboard never creates matchups for. Takes precedence over\n includedTags." + "description": "The tags associated with the prompt, each with an optional category." }, - "lastUpdatedAt": { - "type": "string", - "description": "When votes were last recorded for the leaderboard. Null when no run has ever delivered\n votes to it.", - "format": "date-time", - "nullable": true + "origin": { + "allOf": [ + { + "$ref": "#/components/schemas/Origin" + } + ], + "description": "Where the prompt came from, if known." } } }, - "QueryLeaderboardsEndpoint_PagedResultOfOutput": { + "GetPromptsByBenchmarkEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -55279,166 +51880,338 @@ "type": "integer", "format": "int32" }, - "items": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetPromptsByBenchmarkEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" + } + } + }, + "GetReplicateModelEndpoint_Output": { + "required": [ + "modelOwner", + "modelName", + "supportsImageReference", + "parameters" + ], + "type": "object", + "properties": { + "modelOwner": { + "type": "string", + "description": "The owner of the hosted model." + }, + "modelName": { + "type": "string", + "description": "The model name." + }, + "description": { + "type": "string", + "description": "A short description of the model.", + "nullable": true + }, + "coverImageUrl": { + "type": "string", + "description": "URL of a representative cover image, if available.", + "nullable": true + }, + "runCount": { + "type": "integer", + "description": "Total number of times the model has been run on Replicate, if known.", + "format": "int64", + "nullable": true + }, + "latestVersion": { + "type": "string", + "description": "The model's latest version id, if reported by Replicate.", + "nullable": true + }, + "supportsImageReference": { + "type": "boolean", + "description": "Whether the model accepts a reference image that the platform auto-fills with a prompt's\n attached media. When true that input is excluded from Parameters." + }, + "parameters": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetReplicateModelEndpoint_Parameter" + } + } + ], + "description": "The model's configurable input parameters, ordered for rendering." + } + } + }, + "GetReplicateModelEndpoint_Parameter": { + "required": [ + "key", + "type", + "required", + "enumValues" + ], + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "title": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/ReplicateModelParameterType" + }, + "required": { + "type": "boolean" + }, + "default": {}, + "enumValues": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryLeaderboardsEndpoint_Output" + "type": "string" } }, - "totalPages": { + "minimum": { + "type": "number", + "format": "double", + "nullable": true + }, + "maximum": { + "type": "number", + "format": "double", + "nullable": true + }, + "order": { "type": "integer", - "format": "int32" + "format": "int32", + "nullable": true } } }, - "QueryManagedBenchmarksEndpoint_Output": { + "GetSampleByIdEndpoint_Output": { "required": [ "id", - "name", - "isManaged", - "isPublic", - "isPublished", - "createdAt", - "ownerMail", - "organizationId", - "lastUpdatedAt" + "identifier", + "participantId", + "participantName", + "asset", + "tags" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the benchmark." + "description": "The unique identifier of the sample." }, - "name": { + "identifier": { "type": "string", - "description": "The name of the benchmark." + "description": "The identifier used to correlate samples of different participants." }, - "isManaged": { - "type": "boolean", - "description": "Whether the benchmark is managed." + "participantId": { + "type": "string", + "description": "The id of the participant that owns the sample." }, - "isPublic": { - "type": "boolean", - "description": "Whether the benchmark is public." + "participantName": { + "type": "string", + "description": "The name of the participant that owns the sample." }, - "isPublished": { - "type": "boolean", - "description": "Whether the benchmark is published to the public benchmark repository." + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The asset associated with the sample." + }, + "prompt": { + "type": "string", + "description": "An optional prompt associated with the sample.", + "nullable": true, + "deprecated": true + }, + "englishPrompt": { + "type": "string", + "description": "An optional prompt text translated to English.", + "nullable": true + }, + "originalPrompt": { + "type": "string", + "description": "An optional prompt text as originally provided.", + "nullable": true + }, + "promptAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "An optional prompt asset associated with the sample." + }, + "tags": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The tags associated with the sample." }, "createdAt": { "type": "string", - "description": "The timestamp when the benchmark was created.", + "description": "The timestamp when the sample was created.", "format": "date-time" }, - "ownerMail": { + "ownerId": { "type": "string", - "description": "The mail of the customer owning the benchmark." + "description": "The id of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", + "format": "uuid", + "nullable": true }, - "organizationId": { + "ownerMail": { "type": "string", - "description": "The id of the organization that owns the entity." + "description": "The mail of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", + "nullable": true }, - "lastUpdatedAt": { + "organizationId": { "type": "string", - "description": "When the benchmark's rankings last changed: the latest vote recording across the\n leaderboards contributing to its overall. Null when none of them ever received votes.", - "format": "date-time", + "description": "The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.", "nullable": true } } }, - "QueryManagedBenchmarksEndpoint_PagedResultOfOutput": { + "GetSampleGenerationEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "items" + "id", + "benchmarkId", + "status", + "samplesPerPrompt", + "totalCount", + "completedCount", + "failedCount", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" + "id": { + "type": "string", + "description": "The id of the sample generation request." }, - "page": { + "benchmarkId": { + "type": "string", + "description": "The benchmark this generation belongs to." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/SampleGenerationStatus" + } + ], + "description": "The current status of the generation." + }, + "samplesPerPrompt": { "type": "integer", + "description": "How many samples are being generated per prompt.", "format": "int32" }, - "pageSize": { + "totalCount": { "type": "integer", + "description": "The total number of items queued.", "format": "int32" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryManagedBenchmarksEndpoint_Output" - } + "completedCount": { + "type": "integer", + "description": "The number of items that have succeeded so far.", + "format": "int32" }, - "totalPages": { + "failedCount": { "type": "integer", + "description": "The number of items that have failed.", "format": "int32" - } - } - }, - "QueryMatchupsByBenchmarkEndpoint_Output": { - "required": [ - "items", - "total", - "page", - "pageSize", - "corpus" - ], - "type": "object", - "properties": { - "items": { + }, + "participantIdFilter": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputMatchup" - } + "type": "string" + }, + "nullable": true } ], - "description": "The matchups of this page, in the requested order." - }, - "total": { - "type": "integer", - "description": "The number of matchups the filter leaves — the paging total.", - "format": "int64" + "description": "Optional participant id filter that was applied when this generation was created.", + "deprecated": true }, - "page": { - "type": "integer", - "description": "The 1-based page index.", - "format": "int32" + "participantFilter": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetSampleGenerationEndpoint_Output_Participant" + }, + "nullable": true + } + ], + "description": "The participants (id + display name) this generation was filtered to when it was\n created, or null when no participant filter was applied. A since-deleted participant\n keeps its id with a null name." }, - "pageSize": { - "type": "integer", - "description": "The page size in matchups.", - "format": "int32" + "promptIdentifierFilter": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + ], + "description": "Optional prompt identifier filter that was applied." }, - "corpus": { + "tagsFilter": { "allOf": [ { - "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputCorpus" + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } ], - "description": "Totals over every matched matchup, not just this page." - } - }, - "description": "The queried image matchups output." - }, - "QueryMatchupsByBenchmarkEndpoint_OutputCorpus": { - "required": [ - "totalResponses" - ], - "type": "object", - "properties": { - "totalResponses": { - "type": "integer", - "format": "int64" + "description": "Optional tag filter that was applied." + }, + "ownerId": { + "type": "string", + "description": "The id of the customer that started this generation.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The mail of the customer that started this generation." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "When the generation was created.", + "format": "date-time" } } }, - "QueryMatchupsByBenchmarkEndpoint_OutputLeaderboard": { + "GetSampleGenerationEndpoint_Output_Participant": { "required": [ "id" ], @@ -55453,296 +52226,344 @@ } } }, - "QueryMatchupsByBenchmarkEndpoint_OutputMatchup": { + "GetSampleGenerationItemsEndpoint_Output": { "required": [ - "leaderboard", + "id", + "sampleGenerationId", + "participantId", + "benchmarkPromptId", "promptIdentifier", - "sides", - "responses", - "extremeness", - "latestVotedAt" + "sampleCount", + "status", + "attemptCount", + "sampleIds", + "createdAt" ], "type": "object", "properties": { - "leaderboard": { - "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputLeaderboard" + "id": { + "type": "string", + "description": "The id of the generation item." }, - "promptIdentifier": { - "type": "string" + "sampleGenerationId": { + "type": "string", + "description": "The id of the parent sample generation." }, - "prompt": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputPromptDetails" - } - ], + "participantId": { + "type": "string", + "description": "The participant whose faucet is producing this sample." + }, + "participantName": { + "type": "string", + "description": "The participant's display name, or null if the participant no longer exists.", "nullable": true }, - "sides": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputSide" - } + "benchmarkPromptId": { + "type": "string", + "description": "The benchmark prompt this item targets." }, - "responses": { + "promptIdentifier": { + "type": "string", + "description": "The identifier of the prompt being generated." + }, + "sampleCount": { "type": "integer", - "format": "int64" + "description": "How many samples this item produces for its (participant, prompt) pair.", + "format": "int32" }, - "extremeness": { - "type": "number", - "format": "double" + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/SampleGenerationItemStatus" + } + ], + "description": "The current status of this item." }, - "latestVotedAt": { - "type": "string", - "format": "date-time" - } - } - }, - "QueryMatchupsByBenchmarkEndpoint_OutputPromptDetails": { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "type": "string" + "attemptCount": { + "type": "integer", + "description": "Number of delivery attempts that have been made on this item.", + "format": "int32" }, - "english": { + "providerRequestId": { "type": "string", + "description": "Provider-side request id used to correlate with the provider's logs.", "nullable": true }, - "original": { + "failureReason": { "type": "string", + "description": "Failure reason if the item is in a failed state.", "nullable": true }, - "asset": { - "type": "object", - "oneOf": [ + "sampleIds": { + "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "type": "array", + "items": { + "type": "string" + } } ], - "nullable": true + "description": "The ids of the samples created from this item once it succeeds." + }, + "createdAt": { + "type": "string", + "description": "When the item was created.", + "format": "date-time" } } }, - "QueryMatchupsByBenchmarkEndpoint_OutputSide": { + "GetSampleGenerationItemsEndpoint_PagedResultOfOutput": { "required": [ - "sampleId", - "participantId", - "responses", - "wins" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "sampleId": { - "type": "string" + "total": { + "type": "integer", + "format": "int64" }, - "participantId": { - "type": "string" + "page": { + "type": "integer", + "format": "int32" }, - "participantName": { - "type": "string", - "nullable": true + "pageSize": { + "type": "integer", + "format": "int32" }, - "asset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetSampleGenerationItemsEndpoint_Output" + } }, - "responses": { + "totalPages": { "type": "integer", - "format": "int64" - }, - "wins": { - "type": "number", - "format": "double" + "format": "int32" } } }, - "QueryMatrixByBenchmarkEndpoint_Output": { + "GetSampleNavigationEndpoint_Output": { "required": [ - "index", - "columns", - "data", - "votes" + "current", + "previous", + "next", + "related" ], "type": "object", "properties": { - "index": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The participant names of the matrix rows, ordered strongest first." - }, - "columns": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The participant names of the matrix columns, ordered strongest first." - }, - "data": { + "current": { "allOf": [ { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } + "$ref": "#/components/schemas/GetSampleNavigationEndpoint_Sample" } ], - "description": "The win counts; Data[i][j] holds the wins of Index[i] over Columns[j]." + "description": "The current sample that navigation is anchored on." }, - "votes": { - "allOf": [ - { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - } - ], - "description": "The un-binarized human vote counts on the same axes; Votes[i][j] holds the votes of\n Index[i] over Columns[j]. Display-only — not reflected in the scoring behind Data." - } - } - }, - "QueryMatrixByLeaderboardEndpoint_Output": { - "required": [ - "index", - "columns", - "data" - ], - "type": "object", - "properties": { - "index": { + "previous": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GetSampleNavigationEndpoint_Sample" } } ], - "description": "The participant names of the matrix rows, ordered strongest first." + "description": "Up to three samples of the same participant preceding the current sample,\n ordered ascending by identifier. Empty when the current sample is the first\n of its participant." }, - "columns": { + "next": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/GetSampleNavigationEndpoint_Sample" } } ], - "description": "The participant names of the matrix columns, ordered strongest first." + "description": "Up to three samples of the same participant following the current sample,\n ordered ascending by identifier. Empty when the current sample is the last\n of its participant." }, - "data": { + "related": { "allOf": [ { "type": "array", "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } + "$ref": "#/components/schemas/GetSampleNavigationEndpoint_Sample" } } ], - "description": "The win counts; Data[i][j] holds the wins of Index[i] over Columns[j]." + "description": "Samples of other participants in the same benchmark that share the current\n sample's identifier, ordered by participant name and capped at the requested\n related limit." } } }, - "QueryParticipantsByBenchmarkEndpoint_Output": { + "GetSampleNavigationEndpoint_Sample": { "required": [ "id", - "name", - "benchmarkId", - "status", - "createdAt" + "identifier", + "participantId", + "participantName", + "asset", + "tags" ], "type": "object", "properties": { "id": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "participantId": { + "type": "string" + }, + "participantName": { + "type": "string" + }, + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "prompt": { "type": "string", - "description": "The unique identifier of the participant." + "nullable": true, + "deprecated": true }, - "name": { + "englishPrompt": { "type": "string", - "description": "The name of the participant." + "nullable": true }, - "benchmarkId": { + "originalPrompt": { "type": "string", - "description": "The id of the benchmark the participant belongs to." + "nullable": true }, - "family": { + "promptAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "createdAt": { "type": "string", - "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), or null if unset.", + "format": "date-time" + }, + "ownerId": { + "type": "string", + "format": "uuid", "nullable": true }, - "lab": { + "ownerMail": { "type": "string", - "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"), or null if unset.", "nullable": true }, - "proprietaryName": { + "organizationId": { "type": "string", - "description": "The vendor-facing display name of the model, or null if unset.", "nullable": true + } + } + }, + "GetSamplesByIdentifierEndpoint_Output": { + "required": [ + "id", + "identifier", + "participantId", + "participantName", + "asset", + "tags" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the sample." }, - "licenseType": { + "identifier": { "type": "string", - "oneOf": [ + "description": "The identifier used to correlate samples of different participants." + }, + "participantId": { + "type": "string", + "description": "The id of the participant that owns the sample." + }, + "participantName": { + "type": "string", + "description": "The name of the participant that owns the sample." + }, + "asset": { + "allOf": [ { - "$ref": "#/components/schemas/ModelLicenseType" + "$ref": "#/components/schemas/IAsset" } ], - "description": "The license classification of the underlying model, or null if not classified yet.", + "description": "The asset associated with the sample." + }, + "prompt": { + "type": "string", + "description": "An optional prompt associated with the sample.", + "nullable": true, + "deprecated": true + }, + "englishPrompt": { + "type": "string", + "description": "An optional prompt text translated to English.", "nullable": true }, - "logo": { + "originalPrompt": { "type": "string", - "description": "The logo of the model, or null if unset.", + "description": "An optional prompt text as originally provided.", "nullable": true }, - "status": { + "promptAsset": { "allOf": [ { - "$ref": "#/components/schemas/ParticipantStatus" + "$ref": "#/components/schemas/IAsset" } ], - "description": "The status of the participant." + "description": "An optional prompt asset associated with the sample." + }, + "tags": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The tags associated with the sample." }, "createdAt": { "type": "string", - "description": "When the participant was added to the benchmark.", + "description": "The timestamp when the sample was created.", "format": "date-time" + }, + "ownerId": { + "type": "string", + "description": "The id of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", + "format": "uuid", + "nullable": true + }, + "ownerMail": { + "type": "string", + "description": "The mail of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", + "nullable": true + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.", + "nullable": true } } }, - "QueryParticipantsByBenchmarkEndpoint_PagedResultOfOutput": { + "GetSamplesByIdentifierEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -55766,7 +52587,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryParticipantsByBenchmarkEndpoint_Output" + "$ref": "#/components/schemas/GetSamplesByIdentifierEndpoint_Output" } }, "totalPages": { @@ -55775,292 +52596,383 @@ } } }, - "QueryParticipantsObsoleteEndpoint_Output": { + "GetSamplesByParticipantEndpoint_ISampleOutput": { "required": [ - "items" + "_t" ], "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput" + }, + { + "$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput" + } + ], + "description": "Represents a sample returned for a participant.", + "discriminator": { + "propertyName": "_t", + "mapping": { + "SampleOutput": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput", + "PlaceholderSampleOutput": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput" + } + } + }, + "GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_PlaceholderSampleOutput": { + "required": [ + "identifier", + "tags", + "_t" + ], "properties": { - "items": { + "_t": { + "enum": [ + "PlaceholderSampleOutput" + ], + "type": "string" + }, + "identifier": { + "type": "string", + "description": "The identifier used to correlate samples of different participants." + }, + "prompt": { + "type": "string", + "description": "An optional prompt associated with the sample.", + "nullable": true, + "deprecated": true + }, + "englishPrompt": { + "type": "string", + "description": "An optional prompt text translated to English.", + "nullable": true + }, + "originalPrompt": { + "type": "string", + "description": "An optional prompt text as originally provided.", + "nullable": true + }, + "promptAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "An optional prompt asset associated with the sample." + }, + "tags": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/QueryParticipantsObsoleteEndpoint_OutputItem" + "type": "string" } } ], - "description": "The standings items for the leaderboard." + "description": "The tags associated with the sample." } } }, - "QueryParticipantsObsoleteEndpoint_OutputItem": { + "GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput": { "required": [ "id", - "name", - "leaderboardId", - "status", - "score", - "wins", - "totalMatches", - "isDisabled" + "identifier", + "asset", + "tags", + "_t" ], - "type": "object", "properties": { - "id": { + "_t": { + "enum": [ + "SampleOutput" + ], "type": "string" }, - "name": { - "type": "string" + "id": { + "type": "string", + "description": "The unique identifier of the sample." }, - "leaderboardId": { - "type": "string" + "identifier": { + "type": "string", + "description": "The identifier used to correlate samples of different participants." }, - "status": { - "$ref": "#/components/schemas/StandingStatus" + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The asset associated with the sample." }, - "score": { - "type": "number", - "format": "double", - "nullable": true + "prompt": { + "type": "string", + "description": "An optional prompt associated with the sample.", + "nullable": true, + "deprecated": true }, - "wins": { - "type": "number", - "format": "double" + "englishPrompt": { + "type": "string", + "description": "An optional prompt text translated to English.", + "nullable": true }, - "totalMatches": { - "type": "number", - "format": "double" + "originalPrompt": { + "type": "string", + "description": "An optional prompt text as originally provided.", + "nullable": true }, - "isDisabled": { - "type": "boolean" + "promptAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "An optional prompt asset associated with the sample." }, - "confidenceInterval": { - "type": "object", - "oneOf": [ + "tags": { + "allOf": [ { - "$ref": "#/components/schemas/ConfidenceInterval" + "type": "array", + "items": { + "type": "string" + } } ], + "description": "The tags associated with the sample." + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the sample was created.", + "format": "date-time" + }, + "ownerId": { + "type": "string", + "description": "The id of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", + "format": "uuid", + "nullable": true + }, + "ownerMail": { + "type": "string", + "description": "The mail of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.", + "nullable": true + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.", "nullable": true } } }, - "QueryPromptRatingsByBenchmarkEndpoint_Output": { + "GetSamplesByParticipantEndpoint_PagedResultOfISampleOutput": { "required": [ - "items", "total", "page", "pageSize", - "corpus" + "items" ], "type": "object", "properties": { - "items": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputPrompt" - } - } - ], - "description": "The prompts of this page, each with its ranked entries." - }, "total": { "type": "integer", - "description": "The number of prompts the filter leaves rankable — the paging total.", "format": "int64" }, "page": { "type": "integer", - "description": "The 1-based page index.", "format": "int32" }, "pageSize": { "type": "integer", - "description": "The page size in prompts.", "format": "int32" }, - "corpus": { - "allOf": [ - { - "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputCorpus" - } - ], - "description": "Totals over the whole filtered corpus, not just this page." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetSamplesByParticipantEndpoint_ISampleOutput" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } - }, - "description": "The queried prompt ratings output." + } }, - "QueryPromptRatingsByBenchmarkEndpoint_OutputCorpus": { + "HuggingFaceSyncOutcome": { + "enum": [ + "CreatedPrivate", + "UpdatedPrivate", + "OpenedPullRequest", + "Failed", + null + ] + }, + "HuggingFaceSyncStatus": { + "enum": [ + "NeverSynced", + "Exporting", + "Uploading", + "Completed", + "Failed" + ] + }, + "IFaucetInput": { "required": [ - "totalResponses", - "distinctMatchups" + "_t" ], "type": "object", - "properties": { - "totalResponses": { - "type": "integer", - "format": "int64" - }, - "distinctMatchups": { - "type": "integer", - "format": "int64" + "oneOf": [ + { + "$ref": "#/components/schemas/IFaucetInputReplicateFaucetInput" + } + ], + "description": "Polymorphic request body describing a faucet to configure on a participant. The concrete\n type is selected by the _t discriminator (e.g. \"Replicate\").", + "discriminator": { + "propertyName": "_t", + "mapping": { + "Replicate": "#/components/schemas/IFaucetInputReplicateFaucetInput" } } }, - "QueryPromptRatingsByBenchmarkEndpoint_OutputEntry": { + "IFaucetInputReplicateFaucetInput": { "required": [ - "id", - "participantId", - "images", - "responseCount", - "rating", - "rank" + "modelOwner", + "modelName", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string" - }, - "participantId": { + "_t": { + "enum": [ + "Replicate" + ], "type": "string" }, - "participantName": { + "modelOwner": { "type": "string", - "nullable": true - }, - "images": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputEntryImage" - } + "description": "The owner of the hosted model (e.g. \"stability-ai\")." }, - "responseCount": { - "type": "integer", - "format": "int64" + "modelName": { + "type": "string", + "description": "The model name (e.g. \"sdxl\")." }, - "rating": { - "type": "number", - "format": "double", + "modelVersion": { + "type": "string", + "description": "Optional pinned model version hash.", "nullable": true }, - "rank": { - "type": "integer", - "format": "int32" + "additionalInputs": { + "type": "object", + "description": "Extra model inputs keyed by parameter name (e.g. \"aspect_ratio\"). The system-managed keys\n (prompt, num_outputs) must not appear here — they are supplied automatically. Values are\n validated against the model's live input schema when the faucet is set." } - } + }, + "description": "Configures a faucet that generates samples via the Replicate API." }, - "QueryPromptRatingsByBenchmarkEndpoint_OutputEntryImage": { + "IFaucetOutput": { "required": [ - "sampleId" + "_t" ], "type": "object", - "properties": { - "sampleId": { - "type": "string" + "oneOf": [ + { + "$ref": "#/components/schemas/IFaucetOutputManagedFaucetOutput" }, - "asset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true + { + "$ref": "#/components/schemas/IFaucetOutputReplicateFaucetOutput" } - } - }, - "QueryPromptRatingsByBenchmarkEndpoint_OutputMatrix": { - "required": [ - "wins", - "votes" ], - "type": "object", - "properties": { - "wins": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - }, - "votes": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } + "discriminator": { + "propertyName": "_t", + "mapping": { + "Managed": "#/components/schemas/IFaucetOutputManagedFaucetOutput", + "Replicate": "#/components/schemas/IFaucetOutputReplicateFaucetOutput" } } }, - "QueryPromptRatingsByBenchmarkEndpoint_OutputPrompt": { + "IFaucetOutputManagedFaucetOutput": { "required": [ - "promptIdentifier", - "entries", - "matrix" + "_t" ], - "type": "object", "properties": { - "promptIdentifier": { + "_t": { + "enum": [ + "Managed" + ], "type": "string" }, - "prompt": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputPromptDetails" - } - ], + "testTimeScaling": { + "type": "integer", + "format": "int32", "nullable": true - }, - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputEntry" - } - }, - "matrix": { - "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputMatrix" } } }, - "QueryPromptRatingsByBenchmarkEndpoint_OutputPromptDetails": { + "IFaucetOutputReplicateFaucetOutput": { "required": [ - "id" + "modelOwner", + "modelName", + "additionalInputs", + "_t" ], - "type": "object", "properties": { - "id": { + "_t": { + "enum": [ + "Replicate" + ], "type": "string" }, - "english": { - "type": "string", - "nullable": true + "modelOwner": { + "type": "string" }, - "original": { + "modelName": { + "type": "string" + }, + "modelVersion": { "type": "string", "nullable": true }, - "asset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true + "additionalInputs": { + "type": "object" } } }, - "QueryPublishedBenchmarksEndpoint_Output": { + "MatchupZone": { + "enum": [ + "AClearlyWins", + "CoinFlip", + "BClearlyWins", + null + ] + }, + "ModelLicenseType": { + "enum": [ + "OpenSource", + "Proprietary", + null + ] + }, + "Origin": { + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "type": "string" + } + } + }, + "ParticipantStatus": { + "enum": [ + "Created", + "Submittable", + "Submitted", + "Disabled" + ] + }, + "PromptEmbeddingMapStatus": { + "enum": [ + "Pending", + "Ready", + "Failed" + ] + }, + "QueryBenchmarksEndpoint_Output": { "required": [ "id", "name", @@ -56068,6 +52980,8 @@ "isPublic", "isPublished", "createdAt", + "ownerMail", + "organizationId", "lastUpdatedAt" ], "type": "object", @@ -56099,13 +53013,11 @@ }, "ownerMail": { "type": "string", - "description": "The mail of the customer owning the benchmark. Null unless the caller is platform staff or a member of the owning organization.", - "nullable": true + "description": "The mail of the customer owning the benchmark." }, "organizationId": { "type": "string", - "description": "The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.", - "nullable": true + "description": "The id of the organization that owns the entity." }, "lastUpdatedAt": { "type": "string", @@ -56115,7 +53027,7 @@ } } }, - "QueryPublishedBenchmarksEndpoint_PagedResultOfOutput": { + "QueryBenchmarksEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -56139,7 +53051,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryPublishedBenchmarksEndpoint_Output" + "$ref": "#/components/schemas/QueryBenchmarksEndpoint_Output" } }, "totalPages": { @@ -56148,148 +53060,227 @@ } } }, - "QuerySampleGenerationsByBenchmarkEndpoint_Output": { + "QueryBenchmarkStandingsEndpoint_Output": { "required": [ "id", + "name", "benchmarkId", "status", - "samplesPerPrompt", - "totalCount", - "completedCount", - "failedCount", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" + "score", + "wins", + "totalMatches", + "isDisabled" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The id of the sample generation request." + "description": "The unique identifier of the participant." + }, + "name": { + "type": "string", + "description": "The name of the participant." + }, + "family": { + "type": "string", + "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), or null if unset.", + "nullable": true + }, + "lab": { + "type": "string", + "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"), or null if unset.", + "nullable": true + }, + "proprietaryName": { + "type": "string", + "description": "The vendor-facing display name of the model, or null if unset.", + "nullable": true + }, + "licenseType": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ModelLicenseType" + } + ], + "description": "The license classification of the underlying model, or null if not classified yet.", + "nullable": true + }, + "logo": { + "type": "string", + "description": "The logo of the model, or null if unset.", + "nullable": true }, "benchmarkId": { "type": "string", - "description": "The benchmark this generation belongs to." + "description": "The id of the benchmark this standing belongs to." }, "status": { "allOf": [ { - "$ref": "#/components/schemas/SampleGenerationStatus" + "$ref": "#/components/schemas/StandingStatus" } ], - "description": "The current status of the generation." + "description": "The status of the standing." }, - "samplesPerPrompt": { + "score": { + "type": "number", + "description": "The calculated score, or null if not yet computed.", + "format": "double", + "nullable": true + }, + "wins": { + "type": "number", + "description": "The number of wins.", + "format": "double" + }, + "totalMatches": { + "type": "number", + "description": "The total number of matches.", + "format": "double" + }, + "isDisabled": { + "type": "boolean", + "description": "Whether the participant is disabled." + }, + "confidenceInterval": { + "allOf": [ + { + "$ref": "#/components/schemas/ConfidenceInterval" + } + ], + "description": "The confidence interval bounds, if requested." + } + } + }, + "QueryBenchmarkStandingsEndpoint_PagedResultOfOutput": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { "type": "integer", - "description": "How many samples are being generated per prompt.", - "format": "int32" + "format": "int64" }, - "totalCount": { + "page": { "type": "integer", - "description": "The total number of items queued.", "format": "int32" }, - "completedCount": { + "pageSize": { "type": "integer", - "description": "The number of items that have succeeded so far.", "format": "int32" }, - "failedCount": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryBenchmarkStandingsEndpoint_Output" + } + }, + "totalPages": { "type": "integer", - "description": "The number of items that have failed.", "format": "int32" - }, - "participantIdFilter": { + } + } + }, + "QueryCombinedMatrixByBenchmarksEndpoint_Output": { + "required": [ + "index", + "columns", + "data" + ], + "type": "object", + "properties": { + "index": { "allOf": [ { "type": "array", "items": { "type": "string" - }, - "nullable": true + } } ], - "description": "Optional participant id filter that was applied when this generation was created." + "description": "The participant names of the matrix rows, ordered strongest first." }, - "promptIdentifierFilter": { + "columns": { "allOf": [ { "type": "array", "items": { "type": "string" - }, - "nullable": true + } } ], - "description": "Optional prompt identifier filter that was applied." + "description": "The participant names of the matrix columns, ordered strongest first." }, - "tagsFilter": { + "data": { "allOf": [ { "type": "array", "items": { - "type": "string" - }, - "nullable": true + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } } ], - "description": "Optional tag filter that was applied." - }, - "ownerId": { - "type": "string", - "description": "The id of the customer that started this generation.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The mail of the customer that started this generation." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - }, - "createdAt": { - "type": "string", - "description": "When the generation was created.", - "format": "date-time" + "description": "The win counts; Data[i][j] holds the wins of Index[i] over Columns[j]." } } }, - "QuerySampleGenerationsByBenchmarkEndpoint_PagedResultOfOutput": { + "QueryCombinedMatrixByLeaderboardsEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "items" + "index", + "columns", + "data" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" + "index": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The participant names of the matrix rows, ordered strongest first." }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuerySampleGenerationsByBenchmarkEndpoint_Output" - } + "columns": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The participant names of the matrix columns, ordered strongest first." }, - "totalPages": { - "type": "integer", - "format": "int32" + "data": { + "allOf": [ + { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } + ], + "description": "The win counts; Data[i][j] holds the wins of Index[i] over Columns[j]." } } }, - "QueryStandingsByBenchmarkEndpoint_Output": { + "QueryCombinedStandingsByBenchmarksEndpoint_Output": { "required": [ "items", "totalResponses" @@ -56301,7 +53292,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QueryStandingsByBenchmarkEndpoint_OutputItem" + "$ref": "#/components/schemas/QueryCombinedStandingsByBenchmarksEndpoint_OutputItem" } } ], @@ -56315,7 +53306,7 @@ }, "description": "The queried standings output." }, - "QueryStandingsByBenchmarkEndpoint_OutputItem": { + "QueryCombinedStandingsByBenchmarksEndpoint_OutputItem": { "required": [ "id", "name", @@ -56324,7 +53315,6 @@ "wins", "totalMatches", "responseCount", - "isEvaluating", "isDisabled" ], "type": "object", @@ -56380,9 +53370,6 @@ "type": "integer", "format": "int64" }, - "isEvaluating": { - "type": "boolean" - }, "isDisabled": { "type": "boolean" }, @@ -56397,7 +53384,7 @@ } } }, - "QueryStandingsByLeaderboardEndpoint_Output": { + "QueryCombinedStandingsByLeaderboardsEndpoint_Output": { "required": [ "items", "totalResponses" @@ -56409,7 +53396,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QueryStandingsByLeaderboardEndpoint_OutputItem" + "$ref": "#/components/schemas/QueryCombinedStandingsByLeaderboardsEndpoint_OutputItem" } } ], @@ -56423,7 +53410,7 @@ }, "description": "The queried standings output." }, - "QueryStandingsByLeaderboardEndpoint_OutputItem": { + "QueryCombinedStandingsByLeaderboardsEndpoint_OutputItem": { "required": [ "id", "name", @@ -56501,70 +53488,229 @@ } } }, - "QueryStandingsEndpoint_Output": { + "QueryLeaderboardRunsEndpoint_Output": { "required": [ "id", "name", - "leaderboardId", "status", - "score", - "wins", - "totalMatches", - "isDisabled" + "createdAt", + "ownerMail", + "organizationId", + "orderId", + "jobId", + "audienceId" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the participant." + "description": "The unique identifier of the run." + }, + "name": { + "type": "string", + "description": "The name of the run." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/RunStatus" + } + ], + "description": "The status of the run." + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the run was created.", + "format": "date-time" + }, + "ownerMail": { + "type": "string", + "description": "The mail of the owner of the run." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "orderId": { + "type": "string", + "description": "The id of the associated order, if any.", + "nullable": true + }, + "jobId": { + "type": "string", + "description": "The id of the associated job, if any.", + "nullable": true + }, + "audienceId": { + "type": "string", + "description": "The id of the audience associated with the run." + } + } + }, + "QueryLeaderboardRunsEndpoint_PagedResultOfOutput": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int64" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryLeaderboardRunsEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" + } + } + }, + "QueryLeaderboardsByBenchmarkEndpoint_Output": { + "required": [ + "id", + "name", + "instruction", + "showPrompt", + "showPromptAsset", + "isInversed", + "responseBudget", + "minResponses", + "audienceId", + "featureFlags", + "weight", + "scoreShift", + "scoreScale", + "isHidden", + "isExcludedFromOverall", + "includedTags", + "excludedTags", + "lastUpdatedAt" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the leaderboard." + }, + "name": { + "type": "string", + "description": "The name of the leaderboard." + }, + "instruction": { + "type": "string", + "description": "The instruction shown on the leaderboard." + }, + "showPrompt": { + "type": "boolean", + "description": "Whether the prompt text is shown." + }, + "showPromptAsset": { + "type": "boolean", + "description": "Whether the prompt asset is shown." + }, + "isInversed": { + "type": "boolean", + "description": "Whether the leaderboard's scoring is inversed." + }, + "responseBudget": { + "type": "integer", + "description": "The response budget for the leaderboard.", + "format": "int32" }, - "name": { + "minResponses": { + "type": "integer", + "description": "The minimum number of responses for the leaderboard.", + "format": "int32" + }, + "audienceId": { "type": "string", - "description": "The name of the participant." + "description": "The id of the audience assigned to the leaderboard." }, - "leaderboardId": { + "jobDefinitionId": { "type": "string", - "description": "The id of the leaderboard this standing belongs to." + "description": "The id of the job definition assigned to the leaderboard, if any.", + "nullable": true }, - "status": { + "featureFlags": { "allOf": [ { - "$ref": "#/components/schemas/StandingStatus" + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } } ], - "description": "The status of the standing." + "description": "The feature flags enabled for the leaderboard." }, - "score": { + "weight": { "type": "number", - "description": "The calculated score, or null if not yet computed.", - "format": "double", - "nullable": true + "description": "Multiplier applied to every match result from this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards.", + "format": "double" }, - "wins": { + "scoreShift": { "type": "number", - "description": "The number of wins.", + "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", "format": "double" }, - "totalMatches": { + "scoreScale": { "type": "number", - "description": "The total number of matches.", + "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard.", "format": "double" }, - "isDisabled": { + "isHidden": { "type": "boolean", - "description": "Whether the participant is disabled." + "description": "Whether the leaderboard is hidden in listings and reads for non-admins." }, - "confidenceInterval": { + "isExcludedFromOverall": { + "type": "boolean", + "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard,\n making it a private experiment of the owning organization." + }, + "includedTags": { "allOf": [ { - "$ref": "#/components/schemas/ConfidenceInterval" + "type": "array", + "items": { + "type": "string" + } } ], - "description": "The confidence interval bounds, if requested." + "description": "Prompt tag values the leaderboard restricts its matchups to. Empty means no restriction." + }, + "excludedTags": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Prompt tag values the leaderboard never creates matchups for. Takes precedence over\n includedTags." + }, + "lastUpdatedAt": { + "type": "string", + "description": "When votes were last recorded for the leaderboard. Null when no run has ever delivered\n votes to it.", + "format": "date-time", + "nullable": true } } }, - "QueryStandingsEndpoint_PagedResultOfOutput": { + "QueryLeaderboardsByBenchmarkEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -56588,7 +53734,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryStandingsEndpoint_Output" + "$ref": "#/components/schemas/QueryLeaderboardsByBenchmarkEndpoint_Output" } }, "totalPages": { @@ -56597,1258 +53743,1088 @@ } } }, - "QueryTagsByBenchmarkEndpoint_Output": { - "required": [ - "tags" - ], - "type": "object", - "properties": { - "tags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/TagSummary" - } - } - ], - "description": "The distinct value+category tag pairs associated with the benchmark, each with the number\n of prompts using it." - } - } - }, - "RatingGrouping": { - "enum": [ - "Image", - "Participant" - ], - "description": "What each rated entry of a prompt represents." - }, - "RebalanceLeaderboardEndpoint_Input": { + "QueryLeaderboardsEndpoint_Output": { "required": [ - "participants", - "totalResponses" + "id", + "name", + "instruction", + "showPrompt", + "showPromptAsset", + "isInversed", + "responseBudget", + "minResponses", + "audienceId", + "featureFlags", + "weight", + "scoreShift", + "scoreScale", + "isHidden", + "isExcludedFromOverall", + "voteAggregation", + "includedTags", + "excludedTags", + "lastUpdatedAt" ], "type": "object", "properties": { - "participants": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The participants of the given leaderboard that should receive responses." + "id": { + "type": "string", + "description": "The unique identifier of the leaderboard." }, - "totalResponses": { + "name": { + "type": "string", + "description": "The name of the leaderboard." + }, + "instruction": { + "type": "string", + "description": "The instruction used when collecting responses." + }, + "showPrompt": { + "type": "boolean", + "description": "Whether the prompt is shown on the rapids." + }, + "showPromptAsset": { + "type": "boolean", + "description": "Whether the prompt asset is shown on the rapids." + }, + "isInversed": { + "type": "boolean", + "description": "Whether the leaderboard results are inversed." + }, + "responseBudget": { "type": "integer", - "description": "The total responses to add, shared evenly across all given participants.", + "description": "The response budget per run.", "format": "int32" }, - "seed": { - "type": "integer", - "description": "Optional seed for deterministic matchup selection. Use the same value across leaderboards\n of a benchmark to have them boosted on the same image pairs. Omit for random selection.", - "format": "int64", - "nullable": true - } - } - }, - "ReplicateModelParameterType": { - "enum": [ - "String", - "Integer", - "Number", - "Boolean", - "Uri" - ] - }, - "RetrySampleGenerationEndpoint_Input": { - "type": "object", - "properties": { - "itemIds": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - ], - "description": "The specific item ids to retry. When omitted or empty, every failed item of the\n generation is retried." - } - } - }, - "RetrySampleGenerationEndpoint_Output": { - "required": [ - "retriedCount", - "retriedItemIds" - ], - "type": "object", - "properties": { - "retriedCount": { + "minResponses": { "type": "integer", - "description": "How many failed items were re-queued.", + "description": "The minimum responses collected per comparison.", "format": "int32" }, - "retriedItemIds": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The ids of the items that were re-queued." - } - } - }, - "RunStatus": { - "enum": [ - "Queued", - "Running", - "Completed", - "Failed", - "Paused" - ] - }, - "SampleGenerationItemStatus": { - "enum": [ - "Pending", - "Running", - "Succeeded", - "Failed" - ] - }, - "SampleGenerationStatus": { - "enum": [ - "Pending", - "Processing", - "Completed", - "CompletedWithFailures", - "Failed", - "Cancelled" - ] - }, - "SearchReplicateModelsEndpoint_Model": { - "required": [ - "modelOwner", - "modelName" - ], - "type": "object", - "properties": { - "modelOwner": { - "type": "string" - }, - "modelName": { - "type": "string" - }, - "description": { + "audienceId": { "type": "string", - "nullable": true + "description": "The id of the audience that evaluates the leaderboard." }, - "coverImageUrl": { + "jobDefinitionId": { "type": "string", + "description": "The id of the associated job definition, if any.", "nullable": true }, - "runCount": { - "type": "integer", - "format": "int64", - "nullable": true - } - } - }, - "SearchReplicateModelsEndpoint_Output": { - "required": [ - "models" - ], - "type": "object", - "properties": { - "models": { + "featureFlags": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/SearchReplicateModelsEndpoint_Model" + "$ref": "#/components/schemas/FeatureFlag" } } ], - "description": "The matching models for this page." + "description": "Feature flags applied to orders created from this leaderboard." }, - "nextCursor": { - "type": "string", - "description": "Cursor to fetch the next page, or null when there are no more results.", - "nullable": true - } - } - }, - "StandingStatus": { - "enum": [ - "Created", - "Active", - "Idle" - ] - }, - "StartBenchmarkHuggingFaceSyncEndpoint_Input": { - "type": "object", - "properties": { - "repoName": { - "type": "string", - "description": "Optional target repo name. Only honored while the benchmark has never completed a sync;\n defaults to a name derived from the benchmark name.", - "nullable": true + "weight": { + "type": "number", + "description": "Multiplier applied to every match result from this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards.", + "format": "double" }, - "fullRebuild": { + "scoreShift": { + "type": "number", + "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", + "format": "double" + }, + "scoreScale": { + "type": "number", + "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard.", + "format": "double" + }, + "isHidden": { "type": "boolean", - "description": "When true, re-export the entire benchmark as a non-incremental sync. Defaults to false.", - "nullable": true - } - } - }, - "StartBenchmarkHuggingFaceSyncEndpoint_Output": { - "required": [ - "status" - ], - "type": "object", - "properties": { - "status": { + "description": "Whether the leaderboard is hidden in listings and reads for non-admins." + }, + "isExcludedFromOverall": { + "type": "boolean", + "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard,\n making it a private experiment of the owning organization." + }, + "voteAggregation": { "allOf": [ { - "$ref": "#/components/schemas/HuggingFaceSyncStatus" + "$ref": "#/components/schemas/VoteAggregation" } ], - "description": "Current lifecycle status (NeverSynced when the benchmark has never been synced)." + "description": "How individual votes on a matchup are aggregated into the stored result." }, - "outcome": { - "type": "string", - "oneOf": [ + "includedTags": { + "allOf": [ { - "$ref": "#/components/schemas/HuggingFaceSyncOutcome" + "type": "array", + "items": { + "type": "string" + } } ], - "description": "Outcome of the last completed attempt, or null when none has completed.", - "nullable": true - }, - "repoId": { - "type": "string", - "description": "The target HuggingFace repo id (e.g. Rapidata/svg-benchmark), or null.", - "nullable": true - }, - "repoUrl": { - "type": "string", - "description": "URL of the HuggingFace repo, or null when not yet known.", - "nullable": true + "description": "Prompt tag values the leaderboard restricts its matchups to. Empty means no restriction." }, - "prUrl": { - "type": "string", - "description": "URL of the review pull request opened by the last attempt, or null.", - "nullable": true + "excludedTags": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Prompt tag values the leaderboard never creates matchups for. Takes precedence over\n includedTags." }, - "lastSyncedAt": { + "lastUpdatedAt": { "type": "string", - "description": "When the benchmark was last successfully synced, or null.", + "description": "When votes were last recorded for the leaderboard. Null when no run has ever delivered\n votes to it.", "format": "date-time", "nullable": true - }, - "lastError": { - "type": "string", - "description": "The error from the last failed attempt, or null.", - "nullable": true } } }, - "SubmitParticipantByBenchmarkEndpoint_Output": { + "QueryLeaderboardsEndpoint_PagedResultOfOutput": { "required": [ - "validDatapoints", - "invalidDatapoints" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "validDatapoints": { + "total": { "type": "integer", - "description": "The number of valid datapoints collected by the participant.", - "format": "int32" + "format": "int64" }, - "invalidDatapoints": { + "page": { "type": "integer", - "description": "The number of invalid datapoints collected by the participant.", "format": "int32" - } - } - }, - "SubmitParticipantEndpoint_Output": { - "required": [ - "validDatapoints", - "invalidDatapoints" - ], - "type": "object", - "properties": { - "validDatapoints": { + }, + "pageSize": { "type": "integer", - "description": "The number of valid datapoints collected by the participant.", "format": "int32" }, - "invalidDatapoints": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryLeaderboardsEndpoint_Output" + } + }, + "totalPages": { "type": "integer", - "description": "The number of invalid datapoints collected by the participant.", "format": "int32" } } }, - "Tag": { - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "category": { - "type": "string", - "nullable": true - } - } - }, - "TagSummary": { + "QueryManagedBenchmarksEndpoint_Output": { "required": [ - "value", - "promptCount" + "id", + "name", + "isManaged", + "isPublic", + "isPublished", + "createdAt", + "ownerMail", + "organizationId", + "lastUpdatedAt" ], "type": "object", "properties": { - "value": { - "type": "string" - }, - "category": { + "id": { "type": "string", - "nullable": true + "description": "The unique identifier of the benchmark." }, - "promptCount": { - "type": "integer", - "format": "int32" - } - } - }, - "UpdateBenchmarkEndpoint_Input": { - "type": "object", - "properties": { "name": { "type": "string", - "description": "The new name of the benchmark." + "description": "The name of the benchmark." }, - "description": { - "type": "string", - "description": "Optional plain-text credit for the people or sources behind the benchmark. Limited to\n 2000 characters. Send null to clear it; omit to leave it unchanged." + "isManaged": { + "type": "boolean", + "description": "Whether the benchmark is managed." }, "isPublic": { "type": "boolean", - "description": "Whether the benchmark should be public (only admins can change this)." + "description": "Whether the benchmark is public." }, "isPublished": { "type": "boolean", - "description": "Whether the benchmark should be surfaced in the public benchmark repository (only\n admins can change this)." + "description": "Whether the benchmark is published to the public benchmark repository." }, - "initialBoostLevel": { - "type": "integer", - "description": "Initial boost level applied to the campaign of every run created from this benchmark.\n Admins may set any value the validator allows (0-10) or null to clear the\n override; non-admins are restricted to\n 0..DefaultInitialBoostLevel and may not clear\n it. Both restrictions are enforced by\n IsAllowedToSetInitialBoostLevel with a 403 on\n violation.", - "format": "int32", - "nullable": true + "createdAt": { + "type": "string", + "description": "The timestamp when the benchmark was created.", + "format": "date-time" }, - "scoreShift": { - "type": "number", - "description": "Additive offset applied to displayed scores on the overall scoreboard of this\n benchmark.", - "format": "double" + "ownerMail": { + "type": "string", + "description": "The mail of the customer owning the benchmark." }, - "scoreScale": { - "type": "number", - "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on the overall scoreboard of this benchmark. Must be strictly positive.", - "format": "double" + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "lastUpdatedAt": { + "type": "string", + "description": "When the benchmark's rankings last changed: the latest vote recording across the\n leaderboards contributing to its overall. Null when none of them ever received votes.", + "format": "date-time", + "nullable": true } } }, - "UpdateBenchmarkNameEndpoint_Input": { + "QueryManagedBenchmarksEndpoint_PagedResultOfOutput": { "required": [ - "name" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The new name of the benchmark." - } - } - }, - "UpdateLeaderboardEndpoint_Input": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The new name of the leaderboard." - }, - "responseBudget": { + "total": { "type": "integer", - "description": "The response budget collected when onboarding a new participant.", - "format": "int32" + "format": "int64" }, - "minResponses": { + "page": { "type": "integer", - "description": "The minimum responses collected per matchup.", "format": "int32" }, - "priority": { + "pageSize": { "type": "integer", - "description": "Priority override applied to every run's job. Admin-only. Pass null to clear\n the override and fall back to the default leaderboard priority.", - "format": "int32", - "nullable": true - }, - "weight": { - "type": "number", - "description": "Multiplier applied to every match result of this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards. Unbounded; negative and zero\n values are accepted.", - "format": "double" - }, - "scoreShift": { - "type": "number", - "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", - "format": "double" - }, - "scoreScale": { - "type": "number", - "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard. Must be strictly positive.", - "format": "double" - }, - "isHidden": { - "type": "boolean", - "description": "Whether the leaderboard is hidden from non-admins in listings and reads. Admin-only." - }, - "isExcludedFromOverall": { - "type": "boolean", - "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard.\n When set, the leaderboard becomes an owner-only private experiment: its results do not\n contribute to the overall and it is visible only to its owner and admins." + "format": "int32" }, - "voteAggregation": { - "allOf": [ - { - "$ref": "#/components/schemas/VoteAggregation" - } - ], - "description": "How individual votes on a matchup are aggregated into the stored result. AllVotes\n counts every vote as a matchup; MajorityVote collapses each matchup to a single\n win for the majority side (ties split 0.5/0.5). Only affects future runs." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryManagedBenchmarksEndpoint_Output" + } }, - "includedTags": { + "totalPages": { + "type": "integer", + "format": "int32" + } + } + }, + "QueryMatchupsByBenchmarkEndpoint_Output": { + "required": [ + "items", + "total", + "page", + "pageSize", + "corpus" + ], + "type": "object", + "properties": { + "items": { "allOf": [ { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputMatchup" } } ], - "description": "Prompt tag values to restrict the leaderboard's matchups to. Only prompts carrying at\n least one of these tags are used; an empty list means no restriction." + "description": "The matchups of this page, in the requested order." }, - "excludedTags": { + "total": { + "type": "integer", + "description": "The number of matchups the filter leaves — the paging total.", + "format": "int64" + }, + "page": { + "type": "integer", + "description": "The 1-based page index.", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "description": "The page size in matchups.", + "format": "int32" + }, + "corpus": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputCorpus" } ], - "description": "Prompt tag values the leaderboard never creates matchups for. Takes precedence over\n includedTags: a prompt carrying an excluded tag is skipped even when one of its\n other tags is included." + "description": "Totals over every matched matchup, not just this page." + } + }, + "description": "The queried image matchups output." + }, + "QueryMatchupsByBenchmarkEndpoint_OutputCorpus": { + "required": [ + "totalResponses" + ], + "type": "object", + "properties": { + "totalResponses": { + "type": "integer", + "format": "int64" } } }, - "UpdateLeaderboardNameEndpoint_Input": { + "QueryMatchupsByBenchmarkEndpoint_OutputLeaderboard": { "required": [ - "name" + "id" ], "type": "object", "properties": { + "id": { + "type": "string" + }, "name": { "type": "string", - "description": "The new name of the leaderboard." + "nullable": true } } }, - "UpdateLeaderboardResponseConfigEndpoint_Input": { + "QueryMatchupsByBenchmarkEndpoint_OutputMatchup": { "required": [ - "responseBudget", - "minResponses" + "leaderboard", + "promptIdentifier", + "sides", + "responses", + "extremeness", + "latestVotedAt" ], "type": "object", "properties": { - "responseBudget": { - "type": "integer", - "description": "The response budget collected when onboarding a new participant.", - "format": "int32" + "leaderboard": { + "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputLeaderboard" }, - "minResponses": { + "promptIdentifier": { + "type": "string" + }, + "prompt": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputPromptDetails" + } + ], + "nullable": true + }, + "sides": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryMatchupsByBenchmarkEndpoint_OutputSide" + } + }, + "responses": { "type": "integer", - "description": "The minimum responses collected per matchup.", - "format": "int32" + "format": "int64" + }, + "extremeness": { + "type": "number", + "format": "double" + }, + "latestVotedAt": { + "type": "string", + "format": "date-time" } } }, - "UpdateParticipantEndpoint_Input": { + "QueryMatchupsByBenchmarkEndpoint_OutputPromptDetails": { + "required": [ + "id" + ], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The new name of the participant." - }, - "family": { - "type": "string", - "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"). Pass null to clear.", - "nullable": true + "id": { + "type": "string" }, - "lab": { + "english": { "type": "string", - "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"). Pass null to clear.", "nullable": true }, - "proprietaryName": { + "original": { "type": "string", - "description": "The vendor-facing display name of the model. Pass null to clear.", "nullable": true }, - "licenseType": { - "type": "string", + "asset": { + "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/ModelLicenseType" + "$ref": "#/components/schemas/IAsset" } ], - "description": "The license classification of the underlying model. Pass null to clear.", + "nullable": true + } + } + }, + "QueryMatchupsByBenchmarkEndpoint_OutputSide": { + "required": [ + "sampleId", + "participantId", + "responses", + "wins" + ], + "type": "object", + "properties": { + "sampleId": { + "type": "string" + }, + "participantId": { + "type": "string" + }, + "participantName": { + "type": "string", "nullable": true }, - "logo": { + "asset": { "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/ExistingAssetInput" + "$ref": "#/components/schemas/IAsset" } ], - "description": "An image asset for the model's logo. Pass null to clear.", "nullable": true }, - "faucet": { - "allOf": [ - { - "$ref": "#/components/schemas/IFaucetInput" - } - ], - "description": "The faucet to set or replace on the participant." + "responses": { + "type": "integer", + "format": "int64" + }, + "wins": { + "type": "number", + "format": "double" } } }, - "UpdateParticipantNameEndpoint_Input": { + "QueryMatrixByBenchmarkEndpoint_Output": { "required": [ - "name" + "index", + "columns", + "data", + "votes" ], "type": "object", "properties": { - "name": { - "type": "string", - "description": "The new name of the participant." - } - } - }, - "UpdatePromptTagsEndpoint_Input": { - "type": "object", - "properties": { - "tags": { + "index": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "type": "string" } } ], - "description": "The tags to associate with the prompt, each with an optional category. Omit to leave\n the existing tags unchanged." + "description": "The participant names of the matrix rows, ordered strongest first." }, - "origin": { + "columns": { "allOf": [ { - "$ref": "#/components/schemas/Origin" + "type": "array", + "items": { + "type": "string" + } } ], - "description": "Where the prompt came from. Omit to leave the existing origin unchanged." + "description": "The participant names of the matrix columns, ordered strongest first." + }, + "data": { + "allOf": [ + { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } + ], + "description": "The win counts; Data[i][j] holds the wins of Index[i] over Columns[j]." + }, + "votes": { + "allOf": [ + { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } + ], + "description": "The un-binarized human vote counts on the same axes; Votes[i][j] holds the votes of\n Index[i] over Columns[j]. Display-only — not reflected in the scoring behind Data." } } }, - "VoteAggregation": { - "enum": [ - "AllVotes", - "MajorityVote" - ] - }, - "VoteMatrixResult": { + "QueryMatrixByLeaderboardEndpoint_Output": { "required": [ "index", "columns", - "data", - "votes" + "data" ], "type": "object", "properties": { "index": { - "type": "array", - "items": { - "type": "string" - } + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The participant names of the matrix rows, ordered strongest first." }, "columns": { - "type": "array", - "items": { - "type": "string" - } - }, - "data": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } } - } + ], + "description": "The participant names of the matrix columns, ordered strongest first." }, - "votes": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "number", - "format": "double" + "data": { + "allOf": [ + { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } } - } + ], + "description": "The win counts; Data[i][j] holds the wins of Index[i] over Columns[j]." } } }, - "AgeUserFilter_AgeGroup": { - "enum": [ - "0-17", - "18-29", - "30-39", - "40-49", - "50-64", - "65+" - ] - }, - "AggregatorType": { - "enum": [ - "NonCommittal", - "MajorityVote", - "SimpleMatchup", - "LocateCluster", - "Classification", - "Locate", - "BoundingBox", - "Line", - "Transcription", - "SinglePointLocate", - "FreeText", - "Scrub", - "Ranking", - "MultiRanking", - null - ] - }, - "AttachCategoryRapidBlueprint_Category": { + "QueryParticipantsByBenchmarkEndpoint_Output": { "required": [ - "label", - "value" + "id", + "name", + "benchmarkId", + "status", + "createdAt" ], "type": "object", "properties": { - "label": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "BoundingBoxResult_Box": { - "type": "object", - "properties": { - "xMin": { - "type": "number", - "format": "double", - "nullable": true - }, - "yMin": { - "type": "number", - "format": "double", - "nullable": true + "id": { + "type": "string", + "description": "The unique identifier of the participant." }, - "xMax": { - "type": "number", - "format": "double", - "nullable": true + "name": { + "type": "string", + "description": "The name of the participant." }, - "yMax": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "ClassifyPayload_Category": { - "required": [ - "label" - ], - "type": "object", - "properties": { - "label": { - "type": "string" + "benchmarkId": { + "type": "string", + "description": "The id of the benchmark the participant belongs to." }, - "value": { + "family": { "type": "string", + "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"), or null if unset.", "nullable": true - } - } - }, - "CloneJobDefinitionEndpoint_Input": { - "type": "object", - "properties": { - "definitionName": { + }, + "lab": { "type": "string", - "description": "The name of the new job definition. Defaults to the source definition's name\n suffixed with \"Copy\".", + "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"), or null if unset.", "nullable": true - } - }, - "description": "The input for the clone job definition endpoint." - }, - "CloneJobDefinitionEndpoint_Output": { - "required": [ - "definitionId", - "pipelineId" - ], - "type": "object", - "properties": { - "definitionId": { - "type": "string", - "description": "The id of the cloned job definition." }, - "pipelineId": { + "proprietaryName": { "type": "string", - "description": "The id of the created preview pipeline." - } - }, - "description": "The result when a job definition has been cloned." - }, - "CloneOrderEndpoint_Input": { - "required": [ - "orderName" - ], - "type": "object", - "properties": { - "orderName": { + "description": "The vendor-facing display name of the model, or null if unset.", + "nullable": true + }, + "licenseType": { "type": "string", - "description": "The name of the new cloned order." - } - } - }, - "CloneOrderEndpoint_Output": { - "required": [ - "orderId" - ], - "type": "object", - "properties": { - "datasetId": { + "oneOf": [ + { + "$ref": "#/components/schemas/ModelLicenseType" + } + ], + "description": "The license classification of the underlying model, or null if not classified yet.", + "nullable": true + }, + "logo": { "type": "string", - "description": "The dataset ID of the cloned order.", + "description": "The logo of the model, or null if unset.", "nullable": true }, - "orderId": { + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ParticipantStatus" + } + ], + "description": "The status of the participant." + }, + "createdAt": { "type": "string", - "description": "The ID of the newly cloned order." + "description": "When the participant was added to the benchmark.", + "format": "date-time" } } }, - "ConditionalValidationSelection_ValidationChance": { + "QueryParticipantsByBenchmarkEndpoint_PagedResultOfOutput": { "required": [ - "userScoreThreshold", - "chance", - "rapidCount" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "userScoreThreshold": { - "type": "number", - "format": "double" + "total": { + "type": "integer", + "format": "int64" }, - "chance": { - "type": "number", - "format": "double" + "page": { + "type": "integer", + "format": "int32" }, - "rapidCount": { + "pageSize": { "type": "integer", "format": "int32" }, - "selections": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/ISelection" - }, - "nullable": true + "$ref": "#/components/schemas/QueryParticipantsByBenchmarkEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "CreateComplexOrderEndpoint_Input": { + "QueryParticipantsObsoleteEndpoint_Output": { "required": [ - "orderName", - "pipeline" + "items" ], "type": "object", "properties": { - "orderName": { - "type": "string", - "description": "The name of the order." - }, - "pipeline": { + "items": { "allOf": [ { - "$ref": "#/components/schemas/IPipeline" + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryParticipantsObsoleteEndpoint_OutputItem" + } } ], - "description": "The pipeline configuration to use." - }, - "isDemo": { - "type": "boolean", - "description": "Whether the order is a demo." - }, - "precedingOrderId": { - "type": "string", - "description": "Optional ID of the order that must complete before this order starts processing.", - "nullable": true + "description": "The standings items for the leaderboard." } } }, - "CreateComplexOrderEndpoint_Output": { + "QueryParticipantsObsoleteEndpoint_OutputItem": { "required": [ - "orderId", - "pipelineId" + "id", + "name", + "leaderboardId", + "status", + "score", + "wins", + "totalMatches", + "isDisabled" ], "type": "object", "properties": { - "datasetId": { - "type": "string", - "description": "The dataset ID of the created order.", - "nullable": true + "id": { + "type": "string" }, - "orderId": { - "type": "string", - "description": "The ID of the created order." + "name": { + "type": "string" }, - "campaignId": { - "type": "string", - "description": "The campaign ID of the created order.", + "leaderboardId": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/StandingStatus" + }, + "score": { + "type": "number", + "format": "double", "nullable": true }, - "pipelineId": { - "type": "string", - "description": "The pipeline ID of the created order." + "wins": { + "type": "number", + "format": "double" + }, + "totalMatches": { + "type": "number", + "format": "double" + }, + "isDisabled": { + "type": "boolean" + }, + "confidenceInterval": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ConfidenceInterval" + } + ], + "nullable": true } } }, - "CreateJobDefinitionEndpoint_Input": { + "QueryPromptRatingsByBenchmarkEndpoint_Output": { "required": [ - "definitionName", - "workflow", - "referee", - "datasetId" + "items", + "total", + "page", + "pageSize", + "corpus" ], "type": "object", "properties": { - "definitionName": { - "type": "string", - "description": "The name of the definition." - }, - "workflow": { - "allOf": [ - { - "$ref": "#/components/schemas/IOrderWorkflowInput" - } - ], - "description": "The workflow configuration." - }, - "referee": { - "allOf": [ - { - "$ref": "#/components/schemas/IReferee" - } - ], - "description": "The referee configuration." - }, - "datasetId": { - "type": "string", - "description": "The dataset id." - }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - ], - "description": "The feature flags. Deprecated: use RapidFeatureFlags instead.", - "deprecated": true - }, - "rapidFeatureFlags": { + "items": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputPrompt" } } ], - "description": "The feature flags that apply to each rapid created by this definition." + "description": "The prompts of this page, each with its ranked entries." }, - "campaignFeatureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "The feature flags that apply to the campaign (session-wide) for this definition." + "total": { + "type": "integer", + "description": "The number of prompts the filter leaves rankable — the paging total.", + "format": "int64" }, - "aggregatorType": { - "type": "string", - "oneOf": [ + "page": { + "type": "integer", + "description": "The 1-based page index.", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "description": "The page size in prompts.", + "format": "int32" + }, + "corpus": { + "allOf": [ { - "$ref": "#/components/schemas/AggregatorType" + "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputCorpus" } ], - "description": "The aggregator type.", - "nullable": true + "description": "Totals over the whole filtered corpus, not just this page." } }, - "description": "The input for the create job definition endpoint." + "description": "The queried prompt ratings output." }, - "CreateJobDefinitionEndpoint_Output": { + "QueryPromptRatingsByBenchmarkEndpoint_OutputCorpus": { "required": [ - "definitionId", - "pipelineId" + "totalResponses", + "distinctMatchups" ], "type": "object", "properties": { - "definitionId": { - "type": "string", - "description": "The id of the created job definition." + "totalResponses": { + "type": "integer", + "format": "int64" }, - "pipelineId": { - "type": "string", - "description": "The id of the created preview pipeline." + "distinctMatchups": { + "type": "integer", + "format": "int64" } - }, - "description": "The result when a job definition has been created." + } }, - "CreateJobEndpoint_CostWarning": { + "QueryPromptRatingsByBenchmarkEndpoint_OutputEntry": { "required": [ - "estimatedCost", - "availableBalance", - "shortfall" + "id", + "participantId", + "images", + "responseCount", + "rating", + "rank" ], "type": "object", "properties": { - "estimatedCost": { - "type": "number", - "format": "double" + "id": { + "type": "string" }, - "availableBalance": { - "type": "number", - "format": "double" + "participantId": { + "type": "string" }, - "shortfall": { + "participantName": { + "type": "string", + "nullable": true + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputEntryImage" + } + }, + "responseCount": { + "type": "integer", + "format": "int64" + }, + "rating": { "type": "number", - "format": "double" + "format": "double", + "nullable": true + }, + "rank": { + "type": "integer", + "format": "int32" } } }, - "CreateJobEndpoint_Input": { + "QueryPromptRatingsByBenchmarkEndpoint_OutputEntryImage": { "required": [ - "jobDefinitionId", - "audienceId" + "sampleId" ], "type": "object", "properties": { - "jobDefinitionId": { - "type": "string", - "description": "The id of the job definition to use." - }, - "audienceId": { - "type": "string", - "description": "The id of the audience to target." - }, - "revisionNumber": { - "type": "integer", - "description": "The revision number to use. If not specified, the latest revision will be used.", - "format": "int32", - "nullable": true + "sampleId": { + "type": "string" }, - "name": { - "type": "string", - "description": "The name of the job. If not specified, defaults to \"{definition name}:{revision number}\".", + "asset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], "nullable": true + } + } + }, + "QueryPromptRatingsByBenchmarkEndpoint_OutputMatrix": { + "required": [ + "wins", + "votes" + ], + "type": "object", + "properties": { + "wins": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } }, - "priority": { - "type": "integer", - "description": "The priority of the job. Higher values mean higher priority. When omitted, a\n per-owner default is applied server-side. A requested value is capped for\n non-admin customers.", - "format": "int32", - "nullable": true + "votes": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } + } + }, + "QueryPromptRatingsByBenchmarkEndpoint_OutputPrompt": { + "required": [ + "promptIdentifier", + "entries", + "matrix" + ], + "type": "object", + "properties": { + "promptIdentifier": { + "type": "string" }, - "precedingJobId": { - "type": "string", - "description": "Optional id of a job that must finish before this job starts. When set, this job is\n queued until the preceding job completes or fails.", + "prompt": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputPromptDetails" + } + ], "nullable": true }, - "notifyOwnerOnCompletion": { - "type": "boolean", - "description": "Whether the job's owner should be emailed when the job completes. Defaults to false." + "entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputEntry" + } }, - "checkForExplicitContent": { - "type": "boolean", - "description": "Whether Rapidata's explicit-content check should run for this job. Leave null to use\n the default for the caller's account. Set true to force the check on. Set false to\n skip it — honored only when the account is permitted to skip; otherwise the check\n still runs and ContentCheckSkipDenied is set on the response.", - "nullable": true + "matrix": { + "$ref": "#/components/schemas/QueryPromptRatingsByBenchmarkEndpoint_OutputMatrix" } - }, - "description": "The input for the create job endpoint." + } }, - "CreateJobEndpoint_Output": { + "QueryPromptRatingsByBenchmarkEndpoint_OutputPromptDetails": { "required": [ - "jobId", - "recruitingStarted" + "id" ], "type": "object", "properties": { - "jobId": { - "type": "string", - "description": "The id of the created job." + "id": { + "type": "string" }, - "recruitingStarted": { - "type": "boolean", - "description": "Whether recruiting was automatically started for the audience." + "english": { + "type": "string", + "nullable": true }, - "contentCheckSkipDenied": { - "type": "boolean", - "description": "True when the caller asked to skip the explicit-content check but is not permitted\n to; the check runs regardless. Advisory — the job is created and runs either way." + "original": { + "type": "string", + "nullable": true }, - "costWarning": { - "allOf": [ + "asset": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/CreateJobEndpoint_CostWarning" + "$ref": "#/components/schemas/IAsset" } ], - "description": "Present only when the job's estimated cost exceeds the owner's remaining balance.\n Advisory — the job is created and runs regardless; it may pause for funds mid-run." + "nullable": true } - }, - "description": "The result when a job has been created." + } }, - "CreateJobRevisionEndpoint_Input": { + "QueryPublishedBenchmarksEndpoint_Output": { + "required": [ + "id", + "name", + "isManaged", + "isPublic", + "isPublished", + "createdAt", + "lastUpdatedAt" + ], "type": "object", "properties": { - "workflow": { - "allOf": [ - { - "$ref": "#/components/schemas/IOrderWorkflowInput" - } - ], - "description": "The workflow configuration. If not provided, inherits from the previous revision.\n Must be provided together with Referee if either is specified." - }, - "referee": { - "allOf": [ - { - "$ref": "#/components/schemas/IReferee" - } - ], - "description": "The referee configuration. If not provided, inherits from the previous revision.\n Must be provided together with Workflow if either is specified." + "id": { + "type": "string", + "description": "The unique identifier of the benchmark." }, - "datasetId": { + "name": { "type": "string", - "description": "The dataset id. If not provided, inherits from the previous revision." + "description": "The name of the benchmark." }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "The feature flags. Deprecated: use RapidFeatureFlags instead.\n If not provided, inherits from the previous revision.", - "deprecated": true + "isManaged": { + "type": "boolean", + "description": "Whether the benchmark is managed." }, - "rapidFeatureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "The rapid-level feature flags applied to each rapid created by this revision.\n If not provided, inherits from the previous revision." + "isPublic": { + "type": "boolean", + "description": "Whether the benchmark is public." + }, + "isPublished": { + "type": "boolean", + "description": "Whether the benchmark is published to the public benchmark repository." }, - "campaignFeatureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "The campaign-level (session-wide) feature flags for this revision.\n If not provided, inherits from the previous revision." + "createdAt": { + "type": "string", + "description": "The timestamp when the benchmark was created.", + "format": "date-time" }, - "aggregatorType": { + "ownerMail": { "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/AggregatorType" - } - ], - "description": "The aggregator type. If not provided, inherits from the previous revision.", + "description": "The mail of the customer owning the benchmark. Null unless the caller is platform staff or a member of the owning organization.", "nullable": true }, - "validationSetId": { + "organizationId": { "type": "string", - "description": "A validation set id to pin on this revision. When set, every job run from this\n revision uses the specified validation set as the source of validation rapids\n instead of audience-derived examples. If not provided, inherits from the previous\n revision. Provide a wrapped null value to clear a previously pinned set.", + "description": "The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.", + "nullable": true + }, + "lastUpdatedAt": { + "type": "string", + "description": "When the benchmark's rankings last changed: the latest vote recording across the\n leaderboards contributing to its overall. Null when none of them ever received votes.", + "format": "date-time", "nullable": true } - }, - "description": "The input for the create job revision endpoint." + } }, - "CreateJobRevisionEndpoint_Output": { + "QueryPublishedBenchmarksEndpoint_PagedResultOfOutput": { "required": [ - "revisionNumber", - "pipelineId" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "revisionNumber": { + "total": { + "type": "integer", + "format": "int64" + }, + "page": { "type": "integer", - "description": "The revision number of the created job revision.", "format": "int32" }, - "pipelineId": { - "type": "string", - "description": "The id of the created preview pipeline." + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryPublishedBenchmarksEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } - }, - "description": "The result when a job revision has been created." + } }, - "CreateOrder": { + "QuerySampleGenerationsByBenchmarkEndpoint_Output": { "required": [ - "orderName", - "workflow", - "referee" + "id", + "benchmarkId", + "status", + "samplesPerPrompt", + "totalCount", + "completedCount", + "failedCount", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], "type": "object", "properties": { - "orderName": { + "id": { "type": "string", - "description": "The name is used as an identifier for an order and can be freely chosen." - }, - "workflow": { - "allOf": [ - { - "$ref": "#/components/schemas/IOrderWorkflowInput" - } - ], - "description": "The workflow helps to determine the tasks that need to be completed by the users." - }, - "referee": { - "allOf": [ - { - "$ref": "#/components/schemas/IReferee" - } - ], - "description": "The referee is used to determine how many votes will be collected." + "description": "The id of the sample generation request." }, - "aggregator": { + "benchmarkId": { "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/AggregatorType" - } - ], - "description": "The aggregator is used to determine how the data will be aggregated. The default behavior is enough for most cases", - "nullable": true - }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - ], - "description": "The feature flags are used to enable or disable certain features.", - "deprecated": true + "description": "The benchmark this generation belongs to." }, - "rapidFeatureFlags": { + "status": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true + "$ref": "#/components/schemas/SampleGenerationStatus" } ], - "description": "The feature flags that apply to each rapid created by this order." + "description": "The current status of the generation." }, - "campaignFeatureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - ], - "description": "The feature flags that apply to the campaign (session-wide) for this order." + "samplesPerPrompt": { + "type": "integer", + "description": "How many samples are being generated per prompt.", + "format": "int32" }, - "priority": { + "totalCount": { "type": "integer", - "description": "The priority is used to prioritize over other orders.", - "format": "int32", - "nullable": true + "description": "The total number of items queued.", + "format": "int32" }, - "stickyState": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/StickyState" - } - ], - "description": "Indicates if the underlying campaign should be sticky.", - "nullable": true, - "deprecated": true + "completedCount": { + "type": "integer", + "description": "The number of items that have succeeded so far.", + "format": "int32" }, - "stickyConfig": { - "allOf": [ - { - "$ref": "#/components/schemas/StickyConfig" - } - ], - "description": "Configuration for sticky campaign behavior. Takes precedence over StickyState if both are provided." + "failedCount": { + "type": "integer", + "description": "The number of items that have failed.", + "format": "int32" }, - "userScoreDimensions": { + "participantIdFilter": { "allOf": [ { "type": "array", @@ -57858,9 +54834,9 @@ "nullable": true } ], - "description": "The user score dimensions are used to determine the score of the responses from the user." + "description": "Optional participant id filter that was applied when this generation was created." }, - "demographicKeys": { + "promptIdentifierFilter": { "allOf": [ { "type": "array", @@ -57870,397 +54846,349 @@ "nullable": true } ], - "description": "The demographic keys are used to determine which demographics to store on the responses from the user." - }, - "userFilters": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/IUserFilter" - }, - "nullable": true - } - ], - "description": "The user filters are used to restrict the order to only collect votes from a specific demographic." - }, - "validationSetId": { - "type": "string", - "description": "The validation set id can be changed to point to a specific validation set. if not provided a sane default will be\n used.", - "nullable": true + "description": "Optional prompt identifier filter that was applied." }, - "selections": { + "tagsFilter": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/ISelection" + "type": "string" }, "nullable": true } ], - "description": "The selections are used to determine which tasks are shown to a user." - }, - "retrievalMode": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/RetrievalMode" - } - ], - "description": "The retrieval mode defines how rapids are retrieved from the active labeling pool.", - "nullable": true - }, - "maxIterations": { - "type": "integer", - "description": "The maximum number of times a user is allowed to see the same rapid.", - "format": "int32", - "nullable": true + "description": "Optional tag filter that was applied." }, - "precedingOrderId": { - "type": "string", - "description": "Optional ID of the order that must complete before this order starts processing.", - "nullable": true - } - }, - "description": "This model is used to create a simple order" - }, - "CreateOrderEndpoint_Output": { - "required": [ - "orderId", - "pipelineId" - ], - "type": "object", - "properties": { - "datasetId": { + "ownerId": { "type": "string", - "description": "The dataset ID of the created order.", - "nullable": true + "description": "The id of the customer that started this generation.", + "format": "uuid" }, - "orderId": { + "ownerMail": { "type": "string", - "description": "The ID of the created order." + "description": "The mail of the customer that started this generation." }, - "campaignId": { + "organizationId": { "type": "string", - "description": "The campaign ID of the created order.", - "nullable": true + "description": "The id of the organization that owns the entity." }, - "pipelineId": { + "createdAt": { "type": "string", - "description": "The pipeline ID of the created order." + "description": "When the generation was created.", + "format": "date-time" } } }, - "CreateUnsupportedOrderEndpoint_Input": { + "QuerySampleGenerationsByBenchmarkEndpoint_PagedResultOfOutput": { "required": [ - "orderName", - "dataType", - "labelType" + "total", + "page", + "pageSize", + "items" ], "type": "object", "properties": { - "orderName": { - "type": "string", - "description": "The name of the order." - }, - "dataType": { - "type": "string", - "description": "The type of data that was attempted to be ordered." + "total": { + "type": "integer", + "format": "int64" }, - "labelType": { - "type": "string", - "description": "The type of labels that were attempted to be ordered." - } - } - }, - "DefinitionType": { - "enum": [ - "Unknown", - "Classify", - "Compare", - "BoundingBox", - "Line", - "Polygon", - "Locate", - "Transcription", - "NamedEntity", - "FreeText", - "Scrub", - "Ranking", - "GroupedRanking", - "Evaluation" - ] - }, - "EloConfig": { - "required": [ - "startingScore", - "kFactor", - "scalingFactor" - ], - "type": "object", - "properties": { - "startingScore": { + "page": { "type": "integer", "format": "int32" }, - "kFactor": { + "pageSize": { "type": "integer", "format": "int32" }, - "scalingFactor": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuerySampleGenerationsByBenchmarkEndpoint_Output" + } + }, + "totalPages": { "type": "integer", "format": "int32" } } }, - "GenderUserFilter_Gender": { - "enum": [ - "Male", - "Female", - "Other" - ] - }, - "GetJobAbSummaryEndpoint_Output": { + "QueryStandingsByBenchmarkEndpoint_Output": { "required": [ - "winCounter", - "allTargetGroupsCompleted" + "items", + "totalResponses" ], "type": "object", "properties": { - "winCounter": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - ], - "description": "The win count per compared option." - }, - "allTargetGroupsCompleted": { - "type": "boolean", - "description": "Whether all target groups have completed (result is then final)." - }, - "sideOrder": { + "items": { "allOf": [ { "type": "array", "items": { - "type": "string" - }, - "nullable": true + "$ref": "#/components/schemas/QueryStandingsByBenchmarkEndpoint_OutputItem" + } } ], - "description": "The canonical order of the compared side keys (matching WinCounter's\n keys), so the client can render the sides in a stable order rather than relying on the\n win-counter's dictionary order. Null when the compare blueprint has no defined order." + "description": "The standings items, ordered by score descending." + }, + "totalResponses": { + "type": "integer", + "description": "Total raw human responses (votes) behind these standings under the current filter — the\n actual response count, not the per-participant TotalMatches (which counts\n binarized matchups, so a comparison's several votes collapse into one).", + "format": "int64" } - } + }, + "description": "The queried standings output." }, - "GetJobByIdEndpoint_Output": { + "QueryStandingsByBenchmarkEndpoint_OutputItem": { "required": [ - "jobId", + "id", "name", - "definitionId", - "audienceId", - "revisionNumber", - "pipelineId", - "state", - "isPublic", - "audienceDeleted", - "createdAt", - "ownerId", - "ownerMail", - "organizationId" + "status", + "score", + "wins", + "totalMatches", + "responseCount", + "isEvaluating", + "isDisabled" ], "type": "object", "properties": { - "jobId": { - "type": "string", - "description": "The job id." + "id": { + "type": "string" }, "name": { - "type": "string", - "description": "The job name." + "type": "string" }, - "definitionId": { + "family": { "type": "string", - "description": "The job definition id." + "nullable": true }, - "audienceId": { + "lab": { "type": "string", - "description": "The audience id." - }, - "revisionNumber": { - "type": "integer", - "description": "The revision number.", - "format": "int32" + "nullable": true }, - "pipelineId": { + "proprietaryName": { "type": "string", - "description": "The pipeline id." + "nullable": true }, - "campaignId": { + "licenseType": { "type": "string", - "description": "The job's campaign id. Null when the pipeline did not yield exactly one campaign.", + "oneOf": [ + { + "$ref": "#/components/schemas/ModelLicenseType" + } + ], "nullable": true }, - "audienceName": { + "logo": { "type": "string", - "description": "The audience name, or null when the job's audience has since been deleted (jobs\n outlive their audience).", "nullable": true }, "status": { - "allOf": [ + "$ref": "#/components/schemas/StandingStatus" + }, + "score": { + "type": "number", + "format": "double", + "nullable": true + }, + "wins": { + "type": "number", + "format": "double" + }, + "totalMatches": { + "type": "number", + "format": "double" + }, + "responseCount": { + "type": "integer", + "format": "int64" + }, + "isEvaluating": { + "type": "boolean" + }, + "isDisabled": { + "type": "boolean" + }, + "confidenceInterval": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/AudienceJobState" + "$ref": "#/components/schemas/ConfidenceInterval" } ], - "description": "The job state.", - "deprecated": true - }, - "state": { + "nullable": true + } + } + }, + "QueryStandingsByLeaderboardEndpoint_Output": { + "required": [ + "items", + "totalResponses" + ], + "type": "object", + "properties": { + "items": { "allOf": [ { - "$ref": "#/components/schemas/AudienceJobState" + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryStandingsByLeaderboardEndpoint_OutputItem" + } } ], - "description": "The job state." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the job (and its results) is shared publicly." + "description": "The standings items, ordered by score descending." }, - "audienceDeleted": { - "type": "boolean", - "description": "Whether the audience backing this job was deleted, meaning the job can never run." + "totalResponses": { + "type": "integer", + "description": "Total raw human responses (votes) behind these standings under the current filter — the\n actual response count, not the per-participant TotalMatches (which counts\n binarized matchups, so a comparison's several votes collapse into one).", + "format": "int64" + } + }, + "description": "The queried standings output." + }, + "QueryStandingsByLeaderboardEndpoint_OutputItem": { + "required": [ + "id", + "name", + "status", + "score", + "wins", + "totalMatches", + "responseCount", + "isDisabled" + ], + "type": "object", + "properties": { + "id": { + "type": "string" }, - "completedAt": { - "type": "string", - "description": "The timestamp when the job was completed.", - "format": "date-time", - "nullable": true + "name": { + "type": "string" }, - "resultFileName": { + "family": { "type": "string", - "description": "The file name of the result.", "nullable": true }, - "failedAt": { + "lab": { "type": "string", - "description": "The timestamp when the job failed.", - "format": "date-time", "nullable": true }, - "failureMessage": { + "proprietaryName": { "type": "string", - "description": "The failure message.", "nullable": true }, - "reviewReason": { + "licenseType": { "type": "string", "oneOf": [ { - "$ref": "#/components/schemas/ReviewReason" + "$ref": "#/components/schemas/ModelLicenseType" } ], - "description": "Why the job was routed to manual review, when it is (or was) in\n ManualApproval. Null when no customer-facing reason\n applies.", "nullable": true }, - "createdAt": { + "logo": { "type": "string", - "description": "The creation timestamp.", - "format": "date-time" + "nullable": true }, - "ownerId": { - "type": "string", - "description": "The owner id.", - "format": "uuid" + "status": { + "$ref": "#/components/schemas/StandingStatus" }, - "ownerMail": { - "type": "string", - "description": "The owner email." + "score": { + "type": "number", + "format": "double", + "nullable": true }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - } - }, - "description": "The result when a job has been retrieved." - }, - "GetJobCostEstimateEndpoint_Output": { - "required": [ - "estimatedCost", - "costPerResponse", - "datapointCount", - "requiredResponses" - ], - "type": "object", - "properties": { - "estimatedCost": { + "wins": { "type": "number", - "description": "The estimated total cost of running the job to completion.", "format": "double" }, - "costPerResponse": { + "totalMatches": { "type": "number", - "description": "The representative per-response cost the estimate is based on.", "format": "double" }, - "datapointCount": { + "responseCount": { "type": "integer", - "description": "The number of datapoints in the job's dataset.", "format": "int64" }, - "requiredResponses": { - "type": "integer", - "description": "The total number of responses the job's referee requires to complete.", - "format": "int64" + "isDisabled": { + "type": "boolean" + }, + "confidenceInterval": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ConfidenceInterval" + } + ], + "nullable": true } - }, - "description": "The estimated cost of a job." + } }, - "GetJobDatapointsEndpoint_Output": { + "QueryStandingsEndpoint_Output": { "required": [ "id", - "datasetId", - "asset" + "name", + "leaderboardId", + "status", + "score", + "wins", + "totalMatches", + "isDisabled" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The datapoint id." + "description": "The unique identifier of the participant." }, - "datasetId": { + "name": { "type": "string", - "description": "The id of the dataset the datapoint belongs to." + "description": "The name of the participant." }, - "asset": { + "leaderboardId": { + "type": "string", + "description": "The id of the leaderboard this standing belongs to." + }, + "status": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/StandingStatus" } ], - "description": "The datapoint asset." + "description": "The status of the standing." }, - "context": { - "type": "string", - "description": "The optional textual context.", + "score": { + "type": "number", + "description": "The calculated score, or null if not yet computed.", + "format": "double", "nullable": true }, - "contextAsset": { + "wins": { + "type": "number", + "description": "The number of wins.", + "format": "double" + }, + "totalMatches": { + "type": "number", + "description": "The total number of matches.", + "format": "double" + }, + "isDisabled": { + "type": "boolean", + "description": "Whether the participant is disabled." + }, + "confidenceInterval": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/ConfidenceInterval" } ], - "description": "The optional context asset." + "description": "The confidence interval bounds, if requested." } } }, - "GetJobDatapointsEndpoint_PagedResultOfOutput": { + "QueryStandingsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -58284,7 +55212,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetJobDatapointsEndpoint_Output" + "$ref": "#/components/schemas/QueryStandingsEndpoint_Output" } }, "totalPages": { @@ -58293,6173 +55221,5285 @@ } } }, - "GetJobDefinitionByIdEndpoint_Output": { + "QueryTagsByBenchmarkEndpoint_Output": { "required": [ - "definitionId", - "name", - "definitionType", - "isPublic", - "createdAt", - "ownerId", - "ownerMail", - "organizationId" + "tags" ], "type": "object", "properties": { - "definitionId": { - "type": "string", - "description": "The job definition id." - }, - "name": { - "type": "string", - "description": "The name of the job definition." - }, - "definitionType": { + "tags": { "allOf": [ { - "$ref": "#/components/schemas/DefinitionType" + "type": "array", + "items": { + "$ref": "#/components/schemas/TagSummary" + } } ], - "description": "The type of the job definition." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the definition is shared publicly as a reusable template." - }, - "createdAt": { - "type": "string", - "description": "The creation timestamp.", - "format": "date-time" - }, - "ownerId": { - "type": "string", - "description": "The id of the job definition's owner.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The email of the job definition's owner." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." + "description": "The distinct value+category tag pairs associated with the benchmark, each with the number\n of prompts using it." } - }, - "description": "The result when a job definition has been retrieved." + } }, - "GetJobDefinitionCostEstimateEndpoint_Output": { + "RatingGrouping": { + "enum": [ + "Image", + "Participant" + ], + "description": "What each rated entry of a prompt represents." + }, + "RebalanceLeaderboardEndpoint_Input": { "required": [ - "estimatedCost", - "costPerResponse", - "datapointCount", - "requiredResponses" + "participants", + "totalResponses" ], "type": "object", "properties": { - "estimatedCost": { - "type": "number", - "description": "The estimated total cost of running the definition's latest revision to completion.", - "format": "double" - }, - "costPerResponse": { - "type": "number", - "description": "The representative per-response cost the estimate is based on.", - "format": "double" + "participants": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The participants of the given leaderboard that should receive responses." }, - "datapointCount": { + "totalResponses": { "type": "integer", - "description": "The number of datapoints in the definition's dataset.", - "format": "int64" + "description": "The total responses to add, shared evenly across all given participants.", + "format": "int32" }, - "requiredResponses": { + "seed": { "type": "integer", - "description": "The total number of responses the definition's referee requires to complete.", - "format": "int64" + "description": "Optional seed for deterministic matchup selection. Use the same value across leaderboards\n of a benchmark to have them boosted on the same image pairs. Omit for random selection.", + "format": "int64", + "nullable": true } - }, - "description": "The estimated cost of a job definition." + } }, - "GetJobProgressEndpoint_Output": { - "required": [ - "completionPercentage", - "total", - "completed", - "state" - ], + "ReplicateModelParameterType": { + "enum": [ + "String", + "Integer", + "Number", + "Boolean", + "Uri" + ] + }, + "RetrySampleGenerationEndpoint_Input": { "type": "object", "properties": { - "completionPercentage": { - "type": "number", - "description": "The completion percentage (0–100).", - "format": "double" - }, - "total": { - "type": "integer", - "description": "The total number of rapids.", - "format": "int64" - }, - "completed": { - "type": "integer", - "description": "The number of completed rapids.", - "format": "int64" - }, - "state": { + "itemIds": { "allOf": [ { - "$ref": "#/components/schemas/LabelingState" + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } ], - "description": "The state of the job's labelling." + "description": "The specific item ids to retry. When omitted or empty, every failed item of the\n generation is retried." } } }, - "GetJobResponsesEndpoint_Output": { + "RetrySampleGenerationEndpoint_Output": { "required": [ - "responses" + "retriedCount", + "retriedItemIds" ], "type": "object", "properties": { - "responses": { + "retriedCount": { + "type": "integer", + "description": "How many failed items were re-queued.", + "format": "int32" + }, + "retriedItemIds": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/GetJobResponsesEndpoint_Output_Response" + "type": "string" } } ], - "description": "The responses, newest first by default." + "description": "The ids of the items that were re-queued." } } }, - "GetJobResponsesEndpoint_Output_Response": { + "RunStatus": { + "enum": [ + "Queued", + "Running", + "Completed", + "Failed", + "Paused" + ] + }, + "SampleGenerationItemStatus": { + "enum": [ + "Pending", + "Running", + "Succeeded", + "Failed" + ] + }, + "SampleGenerationStatus": { + "enum": [ + "Pending", + "Processing", + "Completed", + "CompletedWithFailures", + "Failed", + "Cancelled" + ] + }, + "SearchReplicateModelsEndpoint_Model": { "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "result", - "userScore", - "userScores", - "demographicInformation" + "modelOwner", + "modelName" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { + "modelOwner": { "type": "string" }, - "language": { + "modelName": { "type": "string" }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { + "description": { "type": "string", "nullable": true }, - "occupation": { + "coverImageUrl": { "type": "string", "nullable": true }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "GetJobResultNavigationEndpoint_Output": { - "required": [ - "current", - "previous", - "next", - "index", - "total" - ], - "type": "object", - "properties": { - "current": { - "allOf": [ - { - "$ref": "#/components/schemas/JobRapidResult" - } - ], - "description": "The anchor rapid, as a full result." - }, - "previous": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/JobNavigationItem" - } - } - ], - "description": "The rapids preceding the anchor, in ascending order." - }, - "next": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/JobNavigationItem" - } - } - ], - "description": "The rapids following the anchor, in ascending order." - }, - "index": { - "type": "integer", - "description": "The 1-based position of the anchor within the filtered slice.", - "format": "int64" - }, - "total": { + "runCount": { "type": "integer", - "description": "The total number of rapids in the filtered slice.", - "format": "int64" + "format": "int64", + "nullable": true } } }, - "GetJobRevisionEndpoint_Output": { - "required": [ - "definitionId", - "revisionNumber", - "state", - "pipelineId", - "datasetId", - "workflow", - "referee", - "featureFlags", - "createdAt", - "createdById", - "createdByMail" - ], - "type": "object", - "properties": { - "definitionId": { - "type": "string", - "description": "The job definition id." - }, - "revisionNumber": { - "type": "integer", - "description": "The revision number.", - "format": "int32" - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/JobDefinitionRevisionState" - } - ], - "description": "The state of the revision." - }, - "pipelineId": { - "type": "string", - "description": "The pipeline id." - }, - "datasetId": { - "type": "string", - "description": "The dataset id." - }, - "aggregatorType": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/AggregatorType" - } - ], - "description": "The aggregator type.", - "nullable": true - }, - "workflow": { - "allOf": [ - { - "$ref": "#/components/schemas/IOrderWorkflowInput" - } - ], - "description": "The workflow configuration. Can be used directly to create a new revision." - }, - "referee": { - "allOf": [ - { - "$ref": "#/components/schemas/IReferee" - } - ], - "description": "The referee configuration. Can be used directly to create a new revision." - }, - "featureFlags": { + "SearchReplicateModelsEndpoint_Output": { + "required": [ + "models" + ], + "type": "object", + "properties": { + "models": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/SearchReplicateModelsEndpoint_Model" } } ], - "description": "The feature flags." - }, - "createdAt": { - "type": "string", - "description": "The creation timestamp.", - "format": "date-time" + "description": "The matching models for this page." }, - "createdById": { + "nextCursor": { "type": "string", - "description": "The id of the user who created the revision.", - "format": "uuid" - }, - "createdByMail": { + "description": "Cursor to fetch the next page, or null when there are no more results.", + "nullable": true + } + } + }, + "StandingStatus": { + "enum": [ + "Created", + "Active", + "Idle" + ] + }, + "StartBenchmarkHuggingFaceSyncEndpoint_Input": { + "type": "object", + "properties": { + "repoName": { "type": "string", - "description": "The email of the user who created the revision." - }, - "isInstructionComplex": { - "type": "boolean", - "description": "Whether the instruction was flagged as too complex for the average annotator to\n understand. Null until the asynchronous complexity check has completed.", + "description": "Optional target repo name. Only honored while the benchmark has never completed a sync;\n defaults to a name derived from the benchmark name.", "nullable": true }, - "instructionComplexityReason": { - "type": "string", - "description": "A short explanation of why the instruction was flagged, when applicable.", + "fullRebuild": { + "type": "boolean", + "description": "When true, re-export the entire benchmark as a non-incremental sync. Defaults to false.", "nullable": true } - }, - "description": "The result when a job revision has been retrieved." + } }, - "GetOrderByIdEndpoint_Output": { + "StartBenchmarkHuggingFaceSyncEndpoint_Output": { "required": [ - "orderName", - "customerMail", - "orderDate", - "state", - "pipelineId", - "isLocked", - "isPublic" + "status" ], "type": "object", "properties": { - "orderName": { - "type": "string", - "description": "The name of the order." + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/HuggingFaceSyncStatus" + } + ], + "description": "Current lifecycle status (NeverSynced when the benchmark has never been synced)." }, - "customerMail": { + "outcome": { "type": "string", - "description": "The email of the customer who placed the order." + "oneOf": [ + { + "$ref": "#/components/schemas/HuggingFaceSyncOutcome" + } + ], + "description": "Outcome of the last completed attempt, or null when none has completed.", + "nullable": true }, - "orderDate": { + "repoId": { "type": "string", - "description": "The date the order was placed.", - "format": "date-time" + "description": "The target HuggingFace repo id (e.g. Rapidata/svg-benchmark), or null.", + "nullable": true }, - "state": { + "repoUrl": { "type": "string", - "description": "The current state of the order." + "description": "URL of the HuggingFace repo, or null when not yet known.", + "nullable": true }, - "pipelineId": { + "prUrl": { "type": "string", - "description": "The ID of the pipeline associated with the order." - }, - "isLocked": { - "type": "boolean", - "description": "Whether the order is locked." + "description": "URL of the review pull request opened by the last attempt, or null.", + "nullable": true }, - "isPublic": { - "type": "boolean", - "description": "Whether the order is publicly visible." + "lastSyncedAt": { + "type": "string", + "description": "When the benchmark was last successfully synced, or null.", + "format": "date-time", + "nullable": true }, - "failureMessage": { + "lastError": { "type": "string", - "description": "The failure message if the order failed.", + "description": "The error from the last failed attempt, or null.", "nullable": true } } }, - "GetPublicOrdersEndpoint_OrderOutput": { + "SubmitParticipantByBenchmarkEndpoint_Output": { "required": [ - "id", - "name", - "isPublic" + "validDatapoints", + "invalidDatapoints" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" + "validDatapoints": { + "type": "integer", + "description": "The number of valid datapoints collected by the participant.", + "format": "int32" }, - "isPublic": { - "type": "boolean" + "invalidDatapoints": { + "type": "integer", + "description": "The number of invalid datapoints collected by the participant.", + "format": "int32" } } }, - "GetPublicOrdersEndpoint_Output": { + "SubmitParticipantEndpoint_Output": { "required": [ - "orders" + "validDatapoints", + "invalidDatapoints" ], "type": "object", "properties": { - "orders": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetPublicOrdersEndpoint_OrderOutput" - } - } - ], - "description": "The list of publicly available orders." + "validDatapoints": { + "type": "integer", + "description": "The number of valid datapoints collected by the participant.", + "format": "int32" + }, + "invalidDatapoints": { + "type": "integer", + "description": "The number of invalid datapoints collected by the participant.", + "format": "int32" } } }, - "GroupedRankingGroup": { + "Tag": { "required": [ - "id", - "name", - "state", - "pairMakerInformation", - "datapoints", - "totalVotes" + "value" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "state": { + "value": { "type": "string" }, - "pairMakerInformation": { - "$ref": "#/components/schemas/IPairMakerInformation" - }, - "datapoints": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RankingDatapoint" - } - }, - "totalVotes": { - "type": "integer", - "format": "int64" + "category": { + "type": "string", + "nullable": true } } }, - "IDataset": { + "TagSummary": { "required": [ - "_t" + "value", + "promptCount" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IDatasetCloneDataset" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "CloneDatasetModel": "#/components/schemas/IDatasetCloneDataset" - } - } - }, - "IDatasetCloneDataset": { - "required": [ - "datasetToCloneId", - "datasetName", - "_t" - ], "properties": { - "_t": { - "enum": [ - "CloneDatasetModel" - ], + "value": { "type": "string" }, - "datasetToCloneId": { - "type": "string" + "category": { + "type": "string", + "nullable": true }, - "datasetName": { - "type": "string" + "promptCount": { + "type": "integer", + "format": "int32" } } }, - "IJobResults": { - "required": [ - "_t" - ], + "UpdateBenchmarkEndpoint_Input": { "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IJobResultsGroupedRankingResults" + "properties": { + "name": { + "type": "string", + "description": "The new name of the benchmark." }, - { - "$ref": "#/components/schemas/IJobResultsRankingResults" + "description": { + "type": "string", + "description": "Optional plain-text credit for the people or sources behind the benchmark. Limited to\n 2000 characters. Send null to clear it; omit to leave it unchanged." }, - { - "$ref": "#/components/schemas/IJobResultsRapidResults" - } - ], - "description": "The unified job results payload, discriminated by the job's rapid type.", - "discriminator": { - "propertyName": "_t", - "mapping": { - "GroupedRankingResults": "#/components/schemas/IJobResultsGroupedRankingResults", - "RankingResults": "#/components/schemas/IJobResultsRankingResults", - "RapidResults": "#/components/schemas/IJobResultsRapidResults" + "isPublic": { + "type": "boolean", + "description": "Whether the benchmark should be public (only admins can change this)." + }, + "isPublished": { + "type": "boolean", + "description": "Whether the benchmark should be surfaced in the public benchmark repository (only\n admins can change this)." + }, + "initialBoostLevel": { + "type": "integer", + "description": "Initial boost level applied to the campaign of every run created from this benchmark.\n Admins may set any value the validator allows (0-10) or null to clear the\n override; non-admins are restricted to\n 0..DefaultInitialBoostLevel and may not clear\n it. Both restrictions are enforced by\n IsAllowedToSetInitialBoostLevel with a 403 on\n violation.", + "format": "int32", + "nullable": true + }, + "scoreShift": { + "type": "number", + "description": "Additive offset applied to displayed scores on the overall scoreboard of this\n benchmark.", + "format": "double" + }, + "scoreScale": { + "type": "number", + "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on the overall scoreboard of this benchmark. Must be strictly positive.", + "format": "double" } } }, - "IJobResultsGroupedRankingResults": { + "UpdateBenchmarkNameEndpoint_Input": { "required": [ - "total", - "page", - "pageSize", - "items", - "_t" + "name" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "GroupedRankingResults" - ], - "type": "string" + "name": { + "type": "string", + "description": "The new name of the benchmark." + } + } + }, + "UpdateLeaderboardEndpoint_Input": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The new name of the leaderboard." }, - "total": { + "responseBudget": { "type": "integer", - "description": "The total number of sub-rankings.", - "format": "int64" + "description": "The response budget collected when onboarding a new participant.", + "format": "int32" }, - "page": { + "minResponses": { "type": "integer", - "description": "The 1-based page number.", + "description": "The minimum responses collected per matchup.", "format": "int32" }, - "pageSize": { + "priority": { "type": "integer", - "description": "The page size.", - "format": "int32" + "description": "Priority override applied to every run's job. Admin-only. Pass null to clear\n the override and fall back to the default leaderboard priority.", + "format": "int32", + "nullable": true }, - "items": { + "weight": { + "type": "number", + "description": "Multiplier applied to every match result of this leaderboard when it contributes to\n the parent benchmark's overall / combined scoreboards. Unbounded; negative and zero\n values are accepted.", + "format": "double" + }, + "scoreShift": { + "type": "number", + "description": "Additive offset applied to displayed scores on this leaderboard's per-leaderboard\n scoreboard.", + "format": "double" + }, + "scoreScale": { + "type": "number", + "description": "Multiplicative factor applied to displayed scores (relative to the Bradley-Terry\n center) on this leaderboard's per-leaderboard scoreboard. Must be strictly positive.", + "format": "double" + }, + "isHidden": { + "type": "boolean", + "description": "Whether the leaderboard is hidden from non-admins in listings and reads. Admin-only." + }, + "isExcludedFromOverall": { + "type": "boolean", + "description": "Whether the leaderboard is excluded from its benchmark's overall / combined scoreboard.\n When set, the leaderboard becomes an owner-only private experiment: its results do not\n contribute to the overall and it is visible only to its owner and admins." + }, + "voteAggregation": { + "allOf": [ + { + "$ref": "#/components/schemas/VoteAggregation" + } + ], + "description": "How individual votes on a matchup are aggregated into the stored result. AllVotes\n counts every vote as a matchup; MajorityVote collapses each matchup to a single\n win for the majority side (ties split 0.5/0.5). Only affects future runs." + }, + "includedTags": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/GroupedRankingGroup" + "type": "string" } } ], - "description": "The sub-rankings on this page." + "description": "Prompt tag values to restrict the leaderboard's matchups to. Only prompts carrying at\n least one of these tags are used; an empty list means no restriction." + }, + "excludedTags": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Prompt tag values the leaderboard never creates matchups for. Takes precedence over\n includedTags: a prompt carrying an excluded tag is skipped even when one of its\n other tags is included." } - }, - "description": "Results for a grouped-ranking job: a paged list of sub-rankings." + } }, - "IJobResultsRankingResults": { + "UpdateLeaderboardNameEndpoint_Input": { "required": [ - "total", - "page", - "pageSize", - "totalVotes", - "items", - "_t" + "name" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "RankingResults" - ], - "type": "string" - }, - "total": { - "type": "integer", - "description": "The total number of datapoints.", - "format": "int64" - }, - "page": { + "name": { + "type": "string", + "description": "The new name of the leaderboard." + } + } + }, + "UpdateLeaderboardResponseConfigEndpoint_Input": { + "required": [ + "responseBudget", + "minResponses" + ], + "type": "object", + "properties": { + "responseBudget": { "type": "integer", - "description": "The 1-based page number.", + "description": "The response budget collected when onboarding a new participant.", "format": "int32" }, - "pageSize": { + "minResponses": { "type": "integer", - "description": "The page size.", + "description": "The minimum responses collected per matchup.", "format": "int32" + } + } + }, + "UpdateParticipantEndpoint_Input": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The new name of the participant." }, - "totalVotes": { - "type": "integer", - "description": "The total number of votes cast.", - "format": "int64" + "family": { + "type": "string", + "description": "The family the underlying model belongs to (e.g. \"Flux\", \"GPT\"). Pass null to clear.", + "nullable": true }, - "items": { + "lab": { + "type": "string", + "description": "The lab that makes the model (e.g. \"OpenAI\", \"Black Forest Labs\"). Pass null to clear.", + "nullable": true + }, + "proprietaryName": { + "type": "string", + "description": "The vendor-facing display name of the model. Pass null to clear.", + "nullable": true + }, + "licenseType": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ModelLicenseType" + } + ], + "description": "The license classification of the underlying model. Pass null to clear.", + "nullable": true + }, + "logo": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ExistingAssetInput" + } + ], + "description": "An image asset for the model's logo. Pass null to clear.", + "nullable": true + }, + "faucet": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/RankingDatapoint" - } + "$ref": "#/components/schemas/IFaucetInput" } ], - "description": "The ranked datapoints on this page." + "description": "The faucet to set or replace on the participant." } - }, - "description": "Results for a compare (ranking) job: a paged list of Elo-ranked datapoints." + } }, - "IJobResultsRapidResults": { + "UpdateParticipantNameEndpoint_Input": { "required": [ - "total", - "page", - "pageSize", - "items", - "_t" + "name" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "RapidResults" - ], - "type": "string" - }, - "total": { - "type": "integer", - "description": "The total number of rapids.", - "format": "int64" - }, - "page": { - "type": "integer", - "description": "The 1-based page number.", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "description": "The page size.", - "format": "int32" - }, - "items": { + "name": { + "type": "string", + "description": "The new name of the participant." + } + } + }, + "UpdatePromptTagsEndpoint_Input": { + "type": "object", + "properties": { + "tags": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/JobRapidResult" + "$ref": "#/components/schemas/Tag" } } ], - "description": "The rapid cards on this page." - } - }, - "description": "Results for a simple or evaluation job: a paged grid of per-rapid cards." - }, - "IOrderWorkflowInput": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IOrderWorkflowInputEvaluationWorkflowInput" - }, - { - "$ref": "#/components/schemas/IOrderWorkflowInputGroupedRankingWorkflowInput" + "description": "The tags to associate with the prompt, each with an optional category. Omit to leave\n the existing tags unchanged." }, - { - "$ref": "#/components/schemas/IOrderWorkflowInputSimpleWorkflowInput" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "EvaluationWorkflow": "#/components/schemas/IOrderWorkflowInputEvaluationWorkflowInput", - "GroupedRankingWorkflow": "#/components/schemas/IOrderWorkflowInputGroupedRankingWorkflowInput", - "SimpleWorkflow": "#/components/schemas/IOrderWorkflowInputSimpleWorkflowInput" + "origin": { + "allOf": [ + { + "$ref": "#/components/schemas/Origin" + } + ], + "description": "Where the prompt came from. Omit to leave the existing origin unchanged." } } }, - "IOrderWorkflowInputEvaluationWorkflowInput": { + "VoteAggregation": { + "enum": [ + "AllVotes", + "MajorityVote" + ] + }, + "VoteMatrixResult": { "required": [ - "validationSetId", - "shouldAcceptIncorrect", - "_t" + "index", + "columns", + "data", + "votes" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "EvaluationWorkflow" - ], - "type": "string" + "index": { + "type": "array", + "items": { + "type": "string" + } }, - "validationSetId": { - "type": "string" + "columns": { + "type": "array", + "items": { + "type": "string" + } }, - "shouldAcceptIncorrect": { - "type": "boolean" + "data": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } }, - "featureFlags": { + "votes": { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "type": "array", + "items": { + "type": "number", + "format": "double" + } } } } }, - "IOrderWorkflowInputGroupedRankingWorkflowInput": { + "AgeUserFilter_AgeGroup": { + "enum": [ + "0-17", + "18-29", + "30-39", + "40-49", + "50-64", + "65+" + ] + }, + "AggregatorType": { + "enum": [ + "NonCommittal", + "MajorityVote", + "SimpleMatchup", + "LocateCluster", + "Classification", + "Locate", + "BoundingBox", + "Line", + "Transcription", + "SinglePointLocate", + "FreeText", + "Scrub", + "Ranking", + "MultiRanking", + null + ] + }, + "AttachCategoryRapidBlueprint_Category": { "required": [ - "criteria", - "_t" + "label", + "value" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "GroupedRankingWorkflow" - ], + "label": { "type": "string" }, - "criteria": { + "value": { "type": "string" - }, - "pairMakerConfig": { - "$ref": "#/components/schemas/IPairMakerConfig" - }, - "eloConfig": { - "allOf": [ - { - "$ref": "#/components/schemas/EloConfig" - } - ], - "deprecated": true - }, - "rankingConfig": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRankingConfig" - } - ], + } + } + }, + "BoundingBoxResult_Box": { + "type": "object", + "properties": { + "xMin": { + "type": "number", + "format": "double", "nullable": true }, - "contexts": { - "type": "object", - "additionalProperties": { - "type": "string" - }, + "yMin": { + "type": "number", + "format": "double", "nullable": true }, - "contextAssets": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IAssetInput" - }, + "xMax": { + "type": "number", + "format": "double", "nullable": true }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "maxParallelism": { - "type": "integer", - "format": "int32" + "yMax": { + "type": "number", + "format": "double", + "nullable": true } } }, - "IOrderWorkflowInputSimpleWorkflowInput": { + "ClassifyPayload_Category": { "required": [ - "blueprint", - "_t" + "label" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "SimpleWorkflow" - ], + "label": { "type": "string" }, - "blueprint": { - "$ref": "#/components/schemas/IRapidBlueprint" - }, - "batchSize": { - "type": "integer", - "format": "int32", + "value": { + "type": "string", "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } } } }, - "IPairMakerConfig": { - "required": [ - "_t" - ], + "CloneJobDefinitionEndpoint_Input": { "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPairMakerConfigFullPermutationPairMakerConfig" - }, - { - "$ref": "#/components/schemas/IPairMakerConfigOnlinePairMakerConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FullPermutationPairMaker": "#/components/schemas/IPairMakerConfigFullPermutationPairMakerConfig", - "OnlinePairMaker": "#/components/schemas/IPairMakerConfigOnlinePairMakerConfig" - } - } - }, - "IPairMakerConfigFullPermutationPairMakerConfig": { - "required": [ - "_t" - ], "properties": { - "_t": { - "enum": [ - "FullPermutationPairMaker" - ], - "type": "string" + "definitionName": { + "type": "string", + "description": "The name of the new job definition. Defaults to the source definition's name\n suffixed with \"Copy\".", + "nullable": true } - } + }, + "description": "The input for the clone job definition endpoint." }, - "IPairMakerConfigOnlinePairMakerConfig": { + "CloneJobDefinitionEndpoint_Output": { "required": [ - "_t" + "definitionId", + "pipelineId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "OnlinePairMaker" - ], - "type": "string" - }, - "randomMatchesRatio": { - "type": "number", - "format": "float" + "definitionId": { + "type": "string", + "description": "The id of the cloned job definition." }, - "totalComparisonBudget": { - "type": "integer", - "format": "int32" + "pipelineId": { + "type": "string", + "description": "The id of the created preview pipeline." } - } + }, + "description": "The result when a job definition has been cloned." }, - "IPairMakerInformation": { + "CloneOrderEndpoint_Input": { "required": [ - "_t" + "orderName" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPairMakerInformationFullPermutationPairMakerInformation" - }, - { - "$ref": "#/components/schemas/IPairMakerInformationOnlinePairMakerInformation" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FullPermutationPairMakerInformation": "#/components/schemas/IPairMakerInformationFullPermutationPairMakerInformation", - "OnlinePairMakerInformation": "#/components/schemas/IPairMakerInformationOnlinePairMakerInformation" + "properties": { + "orderName": { + "type": "string", + "description": "The name of the new cloned order." } } }, - "IPairMakerInformationFullPermutationPairMakerInformation": { + "CloneOrderEndpoint_Output": { "required": [ - "_t" + "orderId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FullPermutationPairMakerInformation" - ], - "type": "string" + "datasetId": { + "type": "string", + "description": "The dataset ID of the cloned order.", + "nullable": true + }, + "orderId": { + "type": "string", + "description": "The ID of the newly cloned order." } } }, - "IPairMakerInformationOnlinePairMakerInformation": { + "ConditionalValidationSelection_ValidationChance": { "required": [ - "randomMatchesRatio", - "totalComparisonBudget", - "currentComparisonBudget", - "_t" + "userScoreThreshold", + "chance", + "rapidCount" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "OnlinePairMakerInformation" - ], - "type": "string" + "userScoreThreshold": { + "type": "number", + "format": "double" }, - "randomMatchesRatio": { + "chance": { "type": "number", - "format": "float" + "format": "double" }, - "totalComparisonBudget": { + "rapidCount": { "type": "integer", "format": "int32" }, - "currentComparisonBudget": { - "type": "integer", - "format": "int32" + "selections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ISelection" + }, + "nullable": true } } }, - "IPipeline": { + "CreateComplexOrderEndpoint_Input": { "required": [ - "_t" + "orderName", + "pipeline" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineCreateSimplePipeline" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "CreateSimplePipelineModel": "#/components/schemas/IPipelineCreateSimplePipeline" + "properties": { + "orderName": { + "type": "string", + "description": "The name of the order." + }, + "pipeline": { + "allOf": [ + { + "$ref": "#/components/schemas/IPipeline" + } + ], + "description": "The pipeline configuration to use." + }, + "isDemo": { + "type": "boolean", + "description": "Whether the order is a demo." + }, + "precedingOrderId": { + "type": "string", + "description": "Optional ID of the order that must complete before this order starts processing.", + "nullable": true } } }, - "IPipelineArtifact": { + "CreateComplexOrderEndpoint_Output": { "required": [ - "_t" + "orderId", + "pipelineId" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineArtifactCreateDatasetArtifact" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "CreateDatasetArtifactModel": "#/components/schemas/IPipelineArtifactCreateDatasetArtifact" - } - } - }, - "IPipelineArtifactCreateDatasetArtifact": { - "required": [ - "identifier", - "dataset", - "_t" - ], "properties": { - "_t": { - "enum": [ - "CreateDatasetArtifactModel" - ], - "type": "string" + "datasetId": { + "type": "string", + "description": "The dataset ID of the created order.", + "nullable": true }, - "identifier": { - "type": "string" + "orderId": { + "type": "string", + "description": "The ID of the created order." }, - "dataset": { - "$ref": "#/components/schemas/IDataset" + "campaignId": { + "type": "string", + "description": "The campaign ID of the created order.", + "nullable": true + }, + "pipelineId": { + "type": "string", + "description": "The pipeline ID of the created order." } } }, - "IPipelineCreateSimplePipeline": { + "CreateJobDefinitionEndpoint_Input": { "required": [ - "artifacts", - "pipelineSteps", - "namePrefix", - "_t" + "definitionName", + "workflow", + "referee", + "datasetId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "CreateSimplePipelineModel" + "definitionName": { + "type": "string", + "description": "The name of the definition." + }, + "workflow": { + "allOf": [ + { + "$ref": "#/components/schemas/IOrderWorkflowInput" + } ], - "type": "string" + "description": "The workflow configuration." }, - "artifacts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IPipelineArtifact" - } + "referee": { + "allOf": [ + { + "$ref": "#/components/schemas/IReferee" + } + ], + "description": "The referee configuration." }, - "pipelineSteps": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IPipelineStep" - } + "datasetId": { + "type": "string", + "description": "The dataset id." + }, + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "The feature flags. Deprecated: use RapidFeatureFlags instead.", + "deprecated": true + }, + "rapidFeatureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + } + ], + "description": "The feature flags that apply to each rapid created by this definition." + }, + "campaignFeatureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + } + ], + "description": "The feature flags that apply to the campaign (session-wide) for this definition." }, - "namePrefix": { - "type": "string" + "aggregatorType": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/AggregatorType" + } + ], + "description": "The aggregator type.", + "nullable": true } - } + }, + "description": "The input for the create job definition endpoint." }, - "IPipelineStep": { + "CreateJobDefinitionEndpoint_Output": { "required": [ - "_t" + "definitionId", + "pipelineId" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineStepDatasetEvaluationStep" - }, - { - "$ref": "#/components/schemas/IPipelineStepSendCompletionMailStep" - }, - { - "$ref": "#/components/schemas/IPipelineStepWorkflowAggregationStep" + "properties": { + "definitionId": { + "type": "string", + "description": "The id of the created job definition." }, - { - "$ref": "#/components/schemas/IPipelineStepWorkflowLabelingStep" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "DatasetEvaluationStepModel": "#/components/schemas/IPipelineStepDatasetEvaluationStep", - "SendCompletionMailStepModel": "#/components/schemas/IPipelineStepSendCompletionMailStep", - "WorkflowAggregationStepModel": "#/components/schemas/IPipelineStepWorkflowAggregationStep", - "WorkflowLabelingStepModel": "#/components/schemas/IPipelineStepWorkflowLabelingStep" + "pipelineId": { + "type": "string", + "description": "The id of the created preview pipeline." } - } + }, + "description": "The result when a job definition has been created." }, - "IPipelineStepDatasetEvaluationStep": { + "CreateJobEndpoint_CostWarning": { "required": [ - "datasetArtifactId", - "aggregationResultFileArtifactId", - "evaluationResultFileArtifactId", - "receiver", - "_t" + "estimatedCost", + "availableBalance", + "shortfall" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "DatasetEvaluationStepModel" - ], - "type": "string" - }, - "datasetArtifactId": { - "type": "string" - }, - "aggregationResultFileArtifactId": { - "type": "string" + "estimatedCost": { + "type": "number", + "format": "double" }, - "evaluationResultFileArtifactId": { - "type": "string" + "availableBalance": { + "type": "number", + "format": "double" }, - "receiver": { - "type": "string" + "shortfall": { + "type": "number", + "format": "double" } } }, - "IPipelineStepSendCompletionMailStep": { + "CreateJobEndpoint_Input": { "required": [ - "receiver", - "resultsFileArtifactIdentifier", - "_t" + "jobDefinitionId", + "audienceId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "SendCompletionMailStepModel" - ], - "type": "string" + "jobDefinitionId": { + "type": "string", + "description": "The id of the job definition to use." }, - "receiver": { - "type": "string" + "audienceId": { + "type": "string", + "description": "The id of the audience to target." }, - "resultsFileArtifactIdentifier": { - "type": "string" - } - } - }, - "IPipelineStepWorkflowAggregationStep": { - "required": [ - "campaignArtifactId", - "workflowArtifactId", - "fileArtifactId", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "WorkflowAggregationStepModel" - ], - "type": "string" + "revisionNumber": { + "type": "integer", + "description": "The revision number to use. If not specified, the latest revision will be used.", + "format": "int32", + "nullable": true }, - "campaignArtifactId": { - "type": "string" + "name": { + "type": "string", + "description": "The name of the job. If not specified, defaults to \"{definition name}:{revision number}\".", + "nullable": true }, - "workflowArtifactId": { - "type": "string" + "priority": { + "type": "integer", + "description": "The priority of the job. Higher values mean higher priority. When omitted, a\n per-owner default is applied server-side. A requested value is capped for\n non-admin customers.", + "format": "int32", + "nullable": true }, - "fileArtifactId": { - "type": "string" + "precedingJobId": { + "type": "string", + "description": "Optional id of a job that must finish before this job starts. When set, this job is\n queued until the preceding job completes or fails.", + "nullable": true }, - "aggregatorType": { - "$ref": "#/components/schemas/AggregatorType" + "notifyOwnerOnCompletion": { + "type": "boolean", + "description": "Whether the job's owner should be emailed when the job completes. Defaults to false." }, - "demographicKeys": { - "type": "array", - "items": { - "type": "string" - }, + "checkForExplicitContent": { + "type": "boolean", + "description": "Whether Rapidata's explicit-content check should run for this job. Leave null to use\n the default for the caller's account. Set true to force the check on. Set false to\n skip it — honored only when the account is permitted to skip; otherwise the check\n still runs and ContentCheckSkipDenied is set on the response.", "nullable": true } - } + }, + "description": "The input for the create job endpoint." }, - "IPipelineStepWorkflowLabelingStep": { + "CreateJobEndpoint_Output": { "required": [ - "workflowArtifactId", - "_t" + "jobId", + "recruitingStarted" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "WorkflowLabelingStepModel" - ], - "type": "string" + "jobId": { + "type": "string", + "description": "The id of the created job." }, - "workflowArtifactId": { - "type": "string" - } - } - }, - "IRankingConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRankingConfigBradleyTerryRankingConfig" + "recruitingStarted": { + "type": "boolean", + "description": "Whether recruiting was automatically started for the audience." }, - { - "$ref": "#/components/schemas/IRankingConfigEloConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BradleyTerryRankingConfig": "#/components/schemas/IRankingConfigBradleyTerryRankingConfig", - "EloConfig": "#/components/schemas/IRankingConfigEloConfig" + "contentCheckSkipDenied": { + "type": "boolean", + "description": "True when the caller asked to skip the explicit-content check but is not permitted\n to; the check runs regardless. Advisory — the job is created and runs either way." + }, + "costWarning": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateJobEndpoint_CostWarning" + } + ], + "description": "Present only when the job's estimated cost exceeds the owner's remaining balance.\n Advisory — the job is created and runs regardless; it may pause for funds mid-run." } - } + }, + "description": "The result when a job has been created." }, - "IRankingConfigBradleyTerryRankingConfig": { - "required": [ - "startingScore", - "_t" - ], + "CreateJobRevisionEndpoint_Input": { + "type": "object", "properties": { - "_t": { - "enum": [ - "BradleyTerryRankingConfig" + "workflow": { + "allOf": [ + { + "$ref": "#/components/schemas/IOrderWorkflowInput" + } ], - "type": "string" + "description": "The workflow configuration. If not provided, inherits from the previous revision.\n Must be provided together with Referee if either is specified." }, - "startingScore": { - "type": "integer", - "format": "int32" + "referee": { + "allOf": [ + { + "$ref": "#/components/schemas/IReferee" + } + ], + "description": "The referee configuration. If not provided, inherits from the previous revision.\n Must be provided together with Workflow if either is specified." + }, + "datasetId": { + "type": "string", + "description": "The dataset id. If not provided, inherits from the previous revision." + }, + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + } + ], + "description": "The feature flags. Deprecated: use RapidFeatureFlags instead.\n If not provided, inherits from the previous revision.", + "deprecated": true + }, + "rapidFeatureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + } + ], + "description": "The rapid-level feature flags applied to each rapid created by this revision.\n If not provided, inherits from the previous revision." + }, + "campaignFeatureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + } + ], + "description": "The campaign-level (session-wide) feature flags for this revision.\n If not provided, inherits from the previous revision." + }, + "aggregatorType": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/AggregatorType" + } + ], + "description": "The aggregator type. If not provided, inherits from the previous revision.", + "nullable": true + }, + "validationSetId": { + "type": "string", + "description": "A validation set id to pin on this revision. When set, every job run from this\n revision uses the specified validation set as the source of validation rapids\n instead of audience-derived examples. If not provided, inherits from the previous\n revision. Provide a wrapped null value to clear a previously pinned set.", + "nullable": true } - } + }, + "description": "The input for the create job revision endpoint." }, - "IRankingConfigEloConfig": { + "CreateJobRevisionEndpoint_Output": { "required": [ - "startingScore", - "kFactor", - "scalingFactor", - "_t" + "revisionNumber", + "pipelineId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "EloConfig" - ], - "type": "string" - }, - "startingScore": { - "type": "integer", - "format": "int32" - }, - "kFactor": { + "revisionNumber": { "type": "integer", + "description": "The revision number of the created job revision.", "format": "int32" }, - "scalingFactor": { - "type": "integer", - "format": "int32" + "pipelineId": { + "type": "string", + "description": "The id of the created preview pipeline." } - } + }, + "description": "The result when a job revision has been created." }, - "IRapidBlueprint": { + "CreateOrder": { "required": [ - "_t" + "orderName", + "workflow", + "referee" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRapidBlueprintAttachCategoryRapidBlueprint" + "properties": { + "orderName": { + "type": "string", + "description": "The name is used as an identifier for an order and can be freely chosen." }, - { - "$ref": "#/components/schemas/IRapidBlueprintBoundingBoxRapidBlueprint" + "workflow": { + "allOf": [ + { + "$ref": "#/components/schemas/IOrderWorkflowInput" + } + ], + "description": "The workflow helps to determine the tasks that need to be completed by the users." }, - { - "$ref": "#/components/schemas/IRapidBlueprintCompareRapidBlueprint" + "referee": { + "allOf": [ + { + "$ref": "#/components/schemas/IReferee" + } + ], + "description": "The referee is used to determine how many votes will be collected." }, - { - "$ref": "#/components/schemas/IRapidBlueprintFreeTextRapidBlueprint" + "aggregator": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/AggregatorType" + } + ], + "description": "The aggregator is used to determine how the data will be aggregated. The default behavior is enough for most cases", + "nullable": true }, - { - "$ref": "#/components/schemas/IRapidBlueprintLineRapidBlueprint" + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "The feature flags are used to enable or disable certain features.", + "deprecated": true }, - { - "$ref": "#/components/schemas/IRapidBlueprintLocateRapidBlueprint" + "rapidFeatureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "The feature flags that apply to each rapid created by this order." }, - { - "$ref": "#/components/schemas/IRapidBlueprintNamedEntityRapidBlueprint" + "campaignFeatureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "The feature flags that apply to the campaign (session-wide) for this order." }, - { - "$ref": "#/components/schemas/IRapidBlueprintPolygonRapidBlueprint" + "priority": { + "type": "integer", + "description": "The priority is used to prioritize over other orders.", + "format": "int32", + "nullable": true }, - { - "$ref": "#/components/schemas/IRapidBlueprintScrubRapidBlueprint" + "stickyState": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/StickyState" + } + ], + "description": "Indicates if the underlying campaign should be sticky.", + "nullable": true, + "deprecated": true }, - { - "$ref": "#/components/schemas/IRapidBlueprintTranscriptionRapidBlueprint" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassifyBlueprint": "#/components/schemas/IRapidBlueprintAttachCategoryRapidBlueprint", - "BoundingBoxBlueprint": "#/components/schemas/IRapidBlueprintBoundingBoxRapidBlueprint", - "CompareBlueprint": "#/components/schemas/IRapidBlueprintCompareRapidBlueprint", - "FreeTextBlueprint": "#/components/schemas/IRapidBlueprintFreeTextRapidBlueprint", - "LineBlueprint": "#/components/schemas/IRapidBlueprintLineRapidBlueprint", - "LocateBlueprint": "#/components/schemas/IRapidBlueprintLocateRapidBlueprint", - "NamedEntityBlueprint": "#/components/schemas/IRapidBlueprintNamedEntityRapidBlueprint", - "PolygonBlueprint": "#/components/schemas/IRapidBlueprintPolygonRapidBlueprint", - "ScrubBlueprint": "#/components/schemas/IRapidBlueprintScrubRapidBlueprint", - "TranscriptionBlueprint": "#/components/schemas/IRapidBlueprintTranscriptionRapidBlueprint" - } - } - }, - "IRapidBlueprintAttachCategoryRapidBlueprint": { - "required": [ - "categories", - "title", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyBlueprint" + "stickyConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/StickyConfig" + } ], - "type": "string" + "description": "Configuration for sticky campaign behavior. Takes precedence over StickyState if both are provided." }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachCategoryRapidBlueprint_Category" - } + "userScoreDimensions": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + ], + "description": "The user score dimensions are used to determine the score of the responses from the user." + }, + "demographicKeys": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + ], + "description": "The demographic keys are used to determine which demographics to store on the responses from the user." + }, + "userFilters": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/IUserFilter" + }, + "nullable": true + } + ], + "description": "The user filters are used to restrict the order to only collect votes from a specific demographic." }, - "possibleCategories": { - "type": "array", - "items": { - "type": "string" - }, + "validationSetId": { + "type": "string", + "description": "The validation set id can be changed to point to a specific validation set. if not provided a sane default will be\n used.", "nullable": true }, - "title": { - "type": "string" - } - } - }, - "IRapidBlueprintBoundingBoxRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BoundingBoxBlueprint" + "selections": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/ISelection" + }, + "nullable": true + } ], - "type": "string" + "description": "The selections are used to determine which tasks are shown to a user." }, - "target": { - "type": "string" - } - } - }, - "IRapidBlueprintCompareRapidBlueprint": { - "required": [ - "criteria", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CompareBlueprint" + "retrievalMode": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/RetrievalMode" + } ], - "type": "string" + "description": "The retrieval mode defines how rapids are retrieved from the active labeling pool.", + "nullable": true }, - "criteria": { - "type": "string" + "maxIterations": { + "type": "integer", + "description": "The maximum number of times a user is allowed to see the same rapid.", + "format": "int32", + "nullable": true }, - "indexIdentifiers": { - "type": "array", - "items": { - "type": "string" - }, + "precedingOrderId": { + "type": "string", + "description": "Optional ID of the order that must complete before this order starts processing.", "nullable": true } - } + }, + "description": "This model is used to create a simple order" }, - "IRapidBlueprintFreeTextRapidBlueprint": { + "CreateOrderEndpoint_Output": { "required": [ - "question", - "_t" + "orderId", + "pipelineId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FreeTextBlueprint" - ], - "type": "string" + "datasetId": { + "type": "string", + "description": "The dataset ID of the created order.", + "nullable": true }, - "question": { - "type": "string" + "orderId": { + "type": "string", + "description": "The ID of the created order." }, - "shouldValidateResponse": { - "type": "boolean", + "campaignId": { + "type": "string", + "description": "The campaign ID of the created order.", "nullable": true }, - "validationSystemPrompt": { + "pipelineId": { "type": "string", - "nullable": true + "description": "The pipeline ID of the created order." } } }, - "IRapidBlueprintLineRapidBlueprint": { + "CreateUnsupportedOrderEndpoint_Input": { "required": [ - "target", - "_t" + "orderName", + "dataType", + "labelType" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LineBlueprint" - ], - "type": "string" + "orderName": { + "type": "string", + "description": "The name of the order." }, - "target": { - "type": "string" - } - } - }, - "IRapidBlueprintLocateRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocateBlueprint" - ], - "type": "string" + "dataType": { + "type": "string", + "description": "The type of data that was attempted to be ordered." }, - "target": { - "type": "string" + "labelType": { + "type": "string", + "description": "The type of labels that were attempted to be ordered." } } }, - "IRapidBlueprintNamedEntityRapidBlueprint": { + "DefinitionType": { + "enum": [ + "Unknown", + "Classify", + "Compare", + "BoundingBox", + "Line", + "Polygon", + "Locate", + "Transcription", + "NamedEntity", + "FreeText", + "Scrub", + "Ranking", + "GroupedRanking", + "Evaluation" + ] + }, + "EloConfig": { "required": [ - "target", - "classes", - "_t" + "startingScore", + "kFactor", + "scalingFactor" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NamedEntityBlueprint" - ], - "type": "string" + "startingScore": { + "type": "integer", + "format": "int32" }, - "target": { - "type": "string" + "kFactor": { + "type": "integer", + "format": "int32" }, - "classes": { - "type": "array", - "items": { - "type": "string" - } + "scalingFactor": { + "type": "integer", + "format": "int32" } } }, - "IRapidBlueprintPolygonRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } + "GenderUserFilter_Gender": { + "enum": [ + "Male", + "Female", + "Other" + ] }, - "IRapidBlueprintScrubRapidBlueprint": { + "GetJobAbSummaryEndpoint_Output": { "required": [ - "target", - "_t" + "winCounter", + "allTargetGroupsCompleted" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ScrubBlueprint" + "winCounter": { + "allOf": [ + { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double" + } + } ], - "type": "string" + "description": "The win count per compared option." }, - "target": { - "type": "string" - } - } - }, - "IRapidBlueprintTranscriptionRapidBlueprint": { - "required": [ - "title", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TranscriptionBlueprint" - ], - "type": "string" + "allTargetGroupsCompleted": { + "type": "boolean", + "description": "Whether all target groups have completed (result is then final)." }, - "title": { - "type": "string" + "sideOrder": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + ], + "description": "The canonical order of the compared side keys (matching WinCounter's\n keys), so the client can render the sides in a stable order rather than relying on the\n win-counter's dictionary order. Null when the compare blueprint has no defined order." } } }, - "IRapidPayload": { + "GetJobByIdEndpoint_Output": { "required": [ - "_t" + "jobId", + "name", + "definitionId", + "audienceId", + "revisionNumber", + "pipelineId", + "state", + "isPublic", + "audienceDeleted", + "createdAt", + "ownerId", + "ownerMail", + "organizationId" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRapidPayloadBoundingBoxPayload" + "properties": { + "jobId": { + "type": "string", + "description": "The job id." }, - { - "$ref": "#/components/schemas/IRapidPayloadClassifyPayload" + "name": { + "type": "string", + "description": "The job name." }, - { - "$ref": "#/components/schemas/IRapidPayloadComparePayload" + "definitionId": { + "type": "string", + "description": "The job definition id." }, - { - "$ref": "#/components/schemas/IRapidPayloadFreeTextPayload" + "audienceId": { + "type": "string", + "description": "The audience id." }, - { - "$ref": "#/components/schemas/IRapidPayloadLinePayload" + "revisionNumber": { + "type": "integer", + "description": "The revision number.", + "format": "int32" }, - { - "$ref": "#/components/schemas/IRapidPayloadLocatePayload" + "pipelineId": { + "type": "string", + "description": "The pipeline id." }, - { - "$ref": "#/components/schemas/IRapidPayloadNamedEntityPayload" + "campaignId": { + "type": "string", + "description": "The job's campaign id. Null when the pipeline did not yield exactly one campaign.", + "nullable": true }, - { - "$ref": "#/components/schemas/IRapidPayloadPolygonPayload" + "audienceName": { + "type": "string", + "description": "The audience name, or null when the job's audience has since been deleted (jobs\n outlive their audience).", + "nullable": true }, - { - "$ref": "#/components/schemas/IRapidPayloadScrubPayload" + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/AudienceJobState" + } + ], + "description": "The job state.", + "deprecated": true }, - { - "$ref": "#/components/schemas/IRapidPayloadTranscriptionPayload" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BoundingBoxPayload": "#/components/schemas/IRapidPayloadBoundingBoxPayload", - "ClassifyPayload": "#/components/schemas/IRapidPayloadClassifyPayload", - "ComparePayload": "#/components/schemas/IRapidPayloadComparePayload", - "FreeTextPayload": "#/components/schemas/IRapidPayloadFreeTextPayload", - "LinePayload": "#/components/schemas/IRapidPayloadLinePayload", - "LocatePayload": "#/components/schemas/IRapidPayloadLocatePayload", - "NamedEntityPayload": "#/components/schemas/IRapidPayloadNamedEntityPayload", - "PolygonPayload": "#/components/schemas/IRapidPayloadPolygonPayload", - "ScrubPayload": "#/components/schemas/IRapidPayloadScrubPayload", - "TranscriptionPayload": "#/components/schemas/IRapidPayloadTranscriptionPayload" - } - } - }, - "IRapidPayloadBoundingBoxPayload": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BoundingBoxPayload" + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/AudienceJobState" + } ], - "type": "string" + "description": "The job state." }, - "target": { - "type": "string" - } - } - }, - "IRapidPayloadClassifyPayload": { - "required": [ - "categories", - "title", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyPayload" + "isPublic": { + "type": "boolean", + "description": "Whether the job (and its results) is shared publicly." + }, + "audienceDeleted": { + "type": "boolean", + "description": "Whether the audience backing this job was deleted, meaning the job can never run." + }, + "completedAt": { + "type": "string", + "description": "The timestamp when the job was completed.", + "format": "date-time", + "nullable": true + }, + "resultFileName": { + "type": "string", + "description": "The file name of the result.", + "nullable": true + }, + "failedAt": { + "type": "string", + "description": "The timestamp when the job failed.", + "format": "date-time", + "nullable": true + }, + "failureMessage": { + "type": "string", + "description": "The failure message.", + "nullable": true + }, + "reviewReason": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ReviewReason" + } ], - "type": "string" + "description": "Why the job was routed to manual review, when it is (or was) in\n ManualApproval. Null when no customer-facing reason\n applies.", + "nullable": true }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ClassifyPayload_Category" - } + "createdAt": { + "type": "string", + "description": "The creation timestamp.", + "format": "date-time" }, - "title": { - "type": "string" + "ownerId": { + "type": "string", + "description": "The owner id.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The owner email." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." } - } + }, + "description": "The result when a job has been retrieved." }, - "IRapidPayloadComparePayload": { + "GetJobCostEstimateEndpoint_Output": { "required": [ - "criteria", - "_t" + "estimatedCost", + "costPerResponse", + "datapointCount", + "requiredResponses" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ComparePayload" - ], - "type": "string" + "estimatedCost": { + "type": "number", + "description": "The estimated total cost of running the job to completion.", + "format": "double" }, - "criteria": { - "type": "string" + "costPerResponse": { + "type": "number", + "description": "The representative per-response cost the estimate is based on.", + "format": "double" + }, + "datapointCount": { + "type": "integer", + "description": "The number of datapoints in the job's dataset.", + "format": "int64" + }, + "requiredResponses": { + "type": "integer", + "description": "The total number of responses the job's referee requires to complete.", + "format": "int64" } - } + }, + "description": "The estimated cost of a job." }, - "IRapidPayloadFreeTextPayload": { + "GetJobDatapointsEndpoint_Output": { "required": [ - "question", - "_t" + "id", + "datasetId", + "asset" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FreeTextPayload" - ], - "type": "string" + "id": { + "type": "string", + "description": "The datapoint id." }, - "question": { - "type": "string" + "datasetId": { + "type": "string", + "description": "The id of the dataset the datapoint belongs to." }, - "shouldValidateResponse": { - "type": "boolean" + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The datapoint asset." }, - "validationSystemPrompt": { + "context": { "type": "string", + "description": "The optional textual context.", "nullable": true + }, + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The optional context asset." } } }, - "IRapidPayloadLinePayload": { + "GetJobDatapointsEndpoint_PagedResultOfOutput": { "required": [ - "target", - "_t" + "total", + "page", + "pageSize", + "items" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LinePayload" - ], - "type": "string" + "total": { + "type": "integer", + "format": "int64" }, - "target": { - "type": "string" + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetJobDatapointsEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "IRapidPayloadLocatePayload": { + "GetJobDefinitionByIdEndpoint_Output": { "required": [ - "target", - "_t" + "definitionId", + "name", + "definitionType", + "isPublic", + "createdAt", + "ownerId", + "ownerMail", + "organizationId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LocatePayload" + "definitionId": { + "type": "string", + "description": "The job definition id." + }, + "name": { + "type": "string", + "description": "The name of the job definition." + }, + "definitionType": { + "allOf": [ + { + "$ref": "#/components/schemas/DefinitionType" + } ], - "type": "string" + "description": "The type of the job definition." }, - "target": { - "type": "string" + "isPublic": { + "type": "boolean", + "description": "Whether the definition is shared publicly as a reusable template." + }, + "createdAt": { + "type": "string", + "description": "The creation timestamp.", + "format": "date-time" + }, + "ownerId": { + "type": "string", + "description": "The id of the job definition's owner.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The email of the job definition's owner." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." } - } + }, + "description": "The result when a job definition has been retrieved." }, - "IRapidPayloadNamedEntityPayload": { + "GetJobDefinitionCostEstimateEndpoint_Output": { "required": [ - "target", - "classes", - "_t" + "estimatedCost", + "costPerResponse", + "datapointCount", + "requiredResponses" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NamedEntityPayload" - ], - "type": "string" + "estimatedCost": { + "type": "number", + "description": "The estimated total cost of running the definition's latest revision to completion.", + "format": "double" }, - "target": { - "type": "string" + "costPerResponse": { + "type": "number", + "description": "The representative per-response cost the estimate is based on.", + "format": "double" }, - "classes": { - "type": "array", - "items": { - "type": "string" - } + "datapointCount": { + "type": "integer", + "description": "The number of datapoints in the definition's dataset.", + "format": "int64" + }, + "requiredResponses": { + "type": "integer", + "description": "The total number of responses the definition's referee requires to complete.", + "format": "int64" } - } + }, + "description": "The estimated cost of a job definition." }, - "IRapidPayloadPolygonPayload": { + "GetJobProgressEndpoint_Output": { "required": [ - "target", - "_t" + "completionPercentage", + "total", + "completed", + "state" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "PolygonPayload" - ], - "type": "string" + "completionPercentage": { + "type": "number", + "description": "The completion percentage (0–100).", + "format": "double" }, - "target": { - "type": "string" + "total": { + "type": "integer", + "description": "The total number of rapids.", + "format": "int64" + }, + "completed": { + "type": "integer", + "description": "The number of completed rapids.", + "format": "int64" + }, + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/LabelingState" + } + ], + "description": "The state of the job's labelling." } } }, - "IRapidPayloadScrubPayload": { + "GetJobResponsesEndpoint_Output": { "required": [ - "target", - "_t" + "responses" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ScrubPayload" + "responses": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetJobResponsesEndpoint_Output_Response" + } + } ], - "type": "string" - }, - "target": { - "type": "string" + "description": "The responses, newest first by default." } } }, - "IRapidPayloadTranscriptionPayload": { + "GetJobResponsesEndpoint_Output_Response": { "required": [ - "title", - "transcription", - "_t" + "id", + "userId", + "country", + "language", + "age", + "gender", + "occupation", + "result", + "userScore", + "userScores", + "demographicInformation" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "TranscriptionPayload" - ], + "id": { "type": "string" }, - "title": { + "userId": { "type": "string" }, - "transcription": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionPayload_TranscriptionWord" - } - } - } - }, - "IRapidResult": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRapidResultAttachCategoryResult" - }, - { - "$ref": "#/components/schemas/IRapidResultBoundingBoxResult" - }, - { - "$ref": "#/components/schemas/IRapidResultCompareResult" + "country": { + "type": "string" }, - { - "$ref": "#/components/schemas/IRapidResultFreeTextResult" + "language": { + "type": "string" }, - { - "$ref": "#/components/schemas/IRapidResultLineResult" + "age": { + "type": "string", + "nullable": true }, - { - "$ref": "#/components/schemas/IRapidResultLocateResult" + "gender": { + "type": "string", + "nullable": true }, - { - "$ref": "#/components/schemas/IRapidResultNamedEntityResult" + "occupation": { + "type": "string", + "nullable": true }, - { - "$ref": "#/components/schemas/IRapidResultPolygonResult" + "result": { + "$ref": "#/components/schemas/IRapidResult" }, - { - "$ref": "#/components/schemas/IRapidResultScrubResult" + "userScore": { + "type": "number", + "format": "double" }, - { - "$ref": "#/components/schemas/IRapidResultSkipResult" + "userScores": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double" + } }, - { - "$ref": "#/components/schemas/IRapidResultTranscriptionResult" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "AttachCategoryResult": "#/components/schemas/IRapidResultAttachCategoryResult", - "BoundingBoxResult": "#/components/schemas/IRapidResultBoundingBoxResult", - "CompareResult": "#/components/schemas/IRapidResultCompareResult", - "FreeTextResult": "#/components/schemas/IRapidResultFreeTextResult", - "LineResult": "#/components/schemas/IRapidResultLineResult", - "LocateResult": "#/components/schemas/IRapidResultLocateResult", - "NamedEntityResult": "#/components/schemas/IRapidResultNamedEntityResult", - "PolygonResult": "#/components/schemas/IRapidResultPolygonResult", - "ScrubResult": "#/components/schemas/IRapidResultScrubResult", - "SkipResult": "#/components/schemas/IRapidResultSkipResult", - "TranscriptionResult": "#/components/schemas/IRapidResultTranscriptionResult" + "demographicInformation": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "IRapidResultAttachCategoryResult": { + "GetJobResultNavigationEndpoint_Output": { "required": [ - "rapidId", - "category", - "_t" + "current", + "previous", + "next", + "index", + "total" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "AttachCategoryResult" + "current": { + "allOf": [ + { + "$ref": "#/components/schemas/JobRapidResult" + } ], - "type": "string" + "description": "The anchor rapid, as a full result." }, - "rapidId": { - "type": "string" + "previous": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobNavigationItem" + } + } + ], + "description": "The rapids preceding the anchor, in ascending order." }, - "category": { - "type": "string" - } - } - }, - "IRapidResultBoundingBoxResult": { - "required": [ - "rapidId", - "boundingBoxes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BoundingBoxResult" + "next": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobNavigationItem" + } + } ], - "type": "string" + "description": "The rapids following the anchor, in ascending order." }, - "rapidId": { - "type": "string" + "index": { + "type": "integer", + "description": "The 1-based position of the anchor within the filtered slice.", + "format": "int64" }, - "boundingBoxes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BoundingBoxResult_Box" - } + "total": { + "type": "integer", + "description": "The total number of rapids in the filtered slice.", + "format": "int64" } } }, - "IRapidResultCompareResult": { + "GetJobRevisionEndpoint_Output": { "required": [ - "rapidId", - "_t" + "definitionId", + "revisionNumber", + "state", + "pipelineId", + "datasetId", + "workflow", + "referee", + "featureFlags", + "createdAt", + "createdById", + "createdByMail" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "CompareResult" + "definitionId": { + "type": "string", + "description": "The job definition id." + }, + "revisionNumber": { + "type": "integer", + "description": "The revision number.", + "format": "int32" + }, + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/JobDefinitionRevisionState" + } ], - "type": "string" + "description": "The state of the revision." }, - "rapidId": { - "type": "string" + "pipelineId": { + "type": "string", + "description": "The pipeline id." }, - "winners": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IRapidResultFreeTextResult": { - "required": [ - "rapidId", - "answer", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FreeTextResult" + "datasetId": { + "type": "string", + "description": "The dataset id." + }, + "aggregatorType": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/AggregatorType" + } ], - "type": "string" + "description": "The aggregator type.", + "nullable": true }, - "rapidId": { - "type": "string" + "workflow": { + "allOf": [ + { + "$ref": "#/components/schemas/IOrderWorkflowInput" + } + ], + "description": "The workflow configuration. Can be used directly to create a new revision." + }, + "referee": { + "allOf": [ + { + "$ref": "#/components/schemas/IReferee" + } + ], + "description": "The referee configuration. Can be used directly to create a new revision." + }, + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + } + ], + "description": "The feature flags." + }, + "createdAt": { + "type": "string", + "description": "The creation timestamp.", + "format": "date-time" + }, + "createdById": { + "type": "string", + "description": "The id of the user who created the revision.", + "format": "uuid" + }, + "createdByMail": { + "type": "string", + "description": "The email of the user who created the revision." + }, + "isInstructionComplex": { + "type": "boolean", + "description": "Whether the instruction was flagged as too complex for the average annotator to\n understand. Null until the asynchronous complexity check has completed.", + "nullable": true }, - "answer": { - "type": "string" + "instructionComplexityReason": { + "type": "string", + "description": "A short explanation of why the instruction was flagged, when applicable.", + "nullable": true } - } + }, + "description": "The result when a job revision has been retrieved." }, - "IRapidResultLineResult": { + "GetOrderByIdEndpoint_Output": { "required": [ - "rapidId", - "lines", - "_t" + "orderName", + "customerMail", + "orderDate", + "state", + "pipelineId", + "isLocked", + "isPublic" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LineResult" - ], - "type": "string" + "orderName": { + "type": "string", + "description": "The name of the order." }, - "rapidId": { - "type": "string" + "customerMail": { + "type": "string", + "description": "The email of the customer who placed the order." }, - "lines": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineResult_Line" - } + "orderDate": { + "type": "string", + "description": "The date the order was placed.", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "The current state of the order." + }, + "pipelineId": { + "type": "string", + "description": "The ID of the pipeline associated with the order." + }, + "isLocked": { + "type": "boolean", + "description": "Whether the order is locked." + }, + "isPublic": { + "type": "boolean", + "description": "Whether the order is publicly visible." + }, + "failureMessage": { + "type": "string", + "description": "The failure message if the order failed.", + "nullable": true } } }, - "IRapidResultLocateResult": { + "GetPublicOrdersEndpoint_OrderOutput": { "required": [ - "rapidId", - "coordinates", - "_t" + "id", + "name", + "isPublic" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LocateResult" - ], + "id": { "type": "string" }, - "rapidId": { + "name": { "type": "string" }, - "coordinates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LocateCoordinate" - } + "isPublic": { + "type": "boolean" } } }, - "IRapidResultNamedEntityResult": { + "GetPublicOrdersEndpoint_Output": { "required": [ - "rapidId", - "classifications", - "_t" + "orders" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NamedEntityResult" + "orders": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetPublicOrdersEndpoint_OrderOutput" + } + } ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NamedEntityResult_NamedClassification" - } + "description": "The list of publicly available orders." } } }, - "IRapidResultPolygonResult": { + "GroupedRankingGroup": { "required": [ - "rapidId", - "shapes", - "_t" + "id", + "name", + "state", + "pairMakerInformation", + "datapoints", + "totalVotes" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "PolygonResult" - ], + "id": { "type": "string" }, - "rapidId": { + "name": { "type": "string" }, - "shapes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PolygonResult_Shape" - } - } - } - }, - "IRapidResultScrubResult": { - "required": [ - "rapidId", - "timestamps", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScrubResult" - ], + "state": { "type": "string" }, - "rapidId": { - "type": "string" + "pairMakerInformation": { + "$ref": "#/components/schemas/IPairMakerInformation" }, - "timestamps": { + "datapoints": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/RankingDatapoint" } + }, + "totalVotes": { + "type": "integer", + "format": "int64" } } }, - "IRapidResultSkipResult": { + "IDataset": { "required": [ - "rapidId", "_t" ], - "properties": { - "_t": { - "enum": [ - "SkipResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IDatasetCloneDataset" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "CloneDatasetModel": "#/components/schemas/IDatasetCloneDataset" } } }, - "IRapidResultTranscriptionResult": { + "IDatasetCloneDataset": { "required": [ - "rapidId", - "selectedWords", + "datasetToCloneId", + "datasetName", "_t" ], "properties": { "_t": { "enum": [ - "TranscriptionResult" + "CloneDatasetModel" ], "type": "string" }, - "rapidId": { + "datasetToCloneId": { "type": "string" }, - "selectedWords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionResult_TranscriptionWord" - } + "datasetName": { + "type": "string" } } }, - "IReferee": { + "IJobResults": { "required": [ "_t" ], "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/IRefereeBudgetReferee" - }, - { - "$ref": "#/components/schemas/IRefereeEarlyStoppingReferee" + "$ref": "#/components/schemas/IJobResultsGroupedRankingResults" }, { - "$ref": "#/components/schemas/IRefereeNaiveReferee" + "$ref": "#/components/schemas/IJobResultsRankingResults" }, { - "$ref": "#/components/schemas/IRefereeQuorumReferee" + "$ref": "#/components/schemas/IJobResultsRapidResults" } ], + "description": "The unified job results payload, discriminated by the job's rapid type.", "discriminator": { "propertyName": "_t", "mapping": { - "BudgetReferee": "#/components/schemas/IRefereeBudgetReferee", - "EarlyStoppingReferee": "#/components/schemas/IRefereeEarlyStoppingReferee", - "NaiveReferee": "#/components/schemas/IRefereeNaiveReferee", - "QuorumReferee": "#/components/schemas/IRefereeQuorumReferee" + "GroupedRankingResults": "#/components/schemas/IJobResultsGroupedRankingResults", + "RankingResults": "#/components/schemas/IJobResultsRankingResults", + "RapidResults": "#/components/schemas/IJobResultsRapidResults" } } }, - "IRefereeBudgetReferee": { + "IJobResultsGroupedRankingResults": { "required": [ - "totalBudget", + "total", + "page", + "pageSize", + "items", "_t" ], "properties": { "_t": { "enum": [ - "BudgetReferee" + "GroupedRankingResults" ], "type": "string" }, - "totalBudget": { + "total": { + "type": "integer", + "description": "The total number of sub-rankings.", + "format": "int64" + }, + "page": { "type": "integer", + "description": "The 1-based page number.", "format": "int32" - } - } - }, - "IRefereeEarlyStoppingReferee": { - "required": [ - "maxVotes", - "threshold", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "EarlyStoppingReferee" - ], - "type": "string" }, - "maxVotes": { + "pageSize": { "type": "integer", + "description": "The page size.", "format": "int32" }, - "threshold": { - "type": "number", - "format": "double" + "items": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GroupedRankingGroup" + } + } + ], + "description": "The sub-rankings on this page." } - } + }, + "description": "Results for a grouped-ranking job: a paged list of sub-rankings." }, - "IRefereeNaiveReferee": { + "IJobResultsRankingResults": { "required": [ + "total", + "page", + "pageSize", "totalVotes", + "items", "_t" ], "properties": { "_t": { "enum": [ - "NaiveReferee" + "RankingResults" ], "type": "string" }, - "totalVotes": { + "total": { "type": "integer", - "format": "int32" - } - } - }, - "IRefereeQuorumReferee": { - "required": [ - "maxVotes", - "threshold", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "QuorumReferee" - ], - "type": "string" + "description": "The total number of datapoints.", + "format": "int64" }, - "maxVotes": { + "page": { "type": "integer", + "description": "The 1-based page number.", "format": "int32" }, - "threshold": { + "pageSize": { "type": "integer", + "description": "The page size.", "format": "int32" - } - } - }, - "IResponseAggregation": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IResponseAggregationClassifyAggregation" }, - { - "$ref": "#/components/schemas/IResponseAggregationCompareAggregation" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassifyAggregation": "#/components/schemas/IResponseAggregationClassifyAggregation", - "CompareAggregation": "#/components/schemas/IResponseAggregationCompareAggregation" - } - } - }, - "IResponseAggregationClassifyAggregation": { - "required": [ - "categoryTallies", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyAggregation" - ], - "type": "string" + "totalVotes": { + "type": "integer", + "description": "The total number of votes cast.", + "format": "int64" }, - "categoryTallies": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ResponseTally" - } + "items": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/RankingDatapoint" + } + } + ], + "description": "The ranked datapoints on this page." } - } + }, + "description": "Results for a compare (ranking) job: a paged list of Elo-ranked datapoints." }, - "IResponseAggregationCompareAggregation": { + "IJobResultsRapidResults": { "required": [ - "winnerTallies", + "total", + "page", + "pageSize", + "items", "_t" ], "properties": { "_t": { "enum": [ - "CompareAggregation" + "RapidResults" ], "type": "string" }, - "winnerTallies": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ResponseTally" - } + "total": { + "type": "integer", + "description": "The total number of rapids.", + "format": "int64" + }, + "page": { + "type": "integer", + "description": "The 1-based page number.", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "description": "The page size.", + "format": "int32" + }, + "items": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobRapidResult" + } + } + ], + "description": "The rapid cards on this page." } - } + }, + "description": "Results for a simple or evaluation job: a paged grid of per-rapid cards." }, - "ISelection": { + "IOrderWorkflowInput": { "required": [ "_t" ], "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/ISelectionAbTestSelection" - }, - { - "$ref": "#/components/schemas/ISelectionCappedSelection" - }, - { - "$ref": "#/components/schemas/ISelectionConditionalValidationSelection" - }, - { - "$ref": "#/components/schemas/ISelectionDemographicSelection" - }, - { - "$ref": "#/components/schemas/ISelectionEffortCappedSelection" - }, - { - "$ref": "#/components/schemas/ISelectionLabelingSelection" - }, - { - "$ref": "#/components/schemas/ISelectionShufflingSelection" + "$ref": "#/components/schemas/IOrderWorkflowInputEvaluationWorkflowInput" }, { - "$ref": "#/components/schemas/ISelectionStaticSelection" + "$ref": "#/components/schemas/IOrderWorkflowInputGroupedRankingWorkflowInput" }, { - "$ref": "#/components/schemas/ISelectionValidationSelection" + "$ref": "#/components/schemas/IOrderWorkflowInputSimpleWorkflowInput" } ], "discriminator": { "propertyName": "_t", "mapping": { - "AbTestSelection": "#/components/schemas/ISelectionAbTestSelection", - "CappedSelection": "#/components/schemas/ISelectionCappedSelection", - "ConditionalValidationSelection": "#/components/schemas/ISelectionConditionalValidationSelection", - "DemographicSelection": "#/components/schemas/ISelectionDemographicSelection", - "EffortCappedSelection": "#/components/schemas/ISelectionEffortCappedSelection", - "LabelingSelection": "#/components/schemas/ISelectionLabelingSelection", - "ShufflingSelection": "#/components/schemas/ISelectionShufflingSelection", - "StaticSelection": "#/components/schemas/ISelectionStaticSelection", - "ValidationSelection": "#/components/schemas/ISelectionValidationSelection" + "EvaluationWorkflow": "#/components/schemas/IOrderWorkflowInputEvaluationWorkflowInput", + "GroupedRankingWorkflow": "#/components/schemas/IOrderWorkflowInputGroupedRankingWorkflowInput", + "SimpleWorkflow": "#/components/schemas/IOrderWorkflowInputSimpleWorkflowInput" } } }, - "ISelectionAbTestSelection": { + "IOrderWorkflowInputEvaluationWorkflowInput": { "required": [ - "a", - "b", + "validationSetId", + "shouldAcceptIncorrect", "_t" ], "properties": { "_t": { "enum": [ - "AbTestSelection" + "EvaluationWorkflow" ], "type": "string" }, - "a": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ISelection" - } + "validationSetId": { + "type": "string" }, - "b": { + "shouldAcceptIncorrect": { + "type": "boolean" + }, + "featureFlags": { "type": "array", "items": { - "$ref": "#/components/schemas/ISelection" + "$ref": "#/components/schemas/FeatureFlag" } } } }, - "ISelectionCappedSelection": { + "IOrderWorkflowInputGroupedRankingWorkflowInput": { "required": [ - "selections", - "maxRapids", + "criteria", "_t" ], "properties": { "_t": { "enum": [ - "CappedSelection" + "GroupedRankingWorkflow" ], "type": "string" }, - "selections": { + "criteria": { + "type": "string" + }, + "pairMakerConfig": { + "$ref": "#/components/schemas/IPairMakerConfig" + }, + "eloConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/EloConfig" + } + ], + "deprecated": true + }, + "rankingConfig": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IRankingConfig" + } + ], + "nullable": true + }, + "contexts": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "nullable": true + }, + "contextAssets": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/IAssetInput" + }, + "nullable": true + }, + "featureFlags": { "type": "array", "items": { - "$ref": "#/components/schemas/ISelection" + "$ref": "#/components/schemas/FeatureFlag" } }, - "maxRapids": { + "maxParallelism": { "type": "integer", "format": "int32" } } }, - "ISelectionConditionalValidationSelection": { + "IOrderWorkflowInputSimpleWorkflowInput": { "required": [ - "validationSetId", - "validationChances", + "blueprint", "_t" ], "properties": { "_t": { "enum": [ - "ConditionalValidationSelection" + "SimpleWorkflow" ], "type": "string" }, - "validationSetId": { - "type": "string" + "blueprint": { + "$ref": "#/components/schemas/IRapidBlueprint" }, - "validationChances": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConditionalValidationSelection_ValidationChance" - } + "batchSize": { + "type": "integer", + "format": "int32", + "nullable": true }, - "dimensions": { + "featureFlags": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/FeatureFlag" } } } }, - "ISelectionDemographicSelection": { + "IPairMakerConfig": { "required": [ - "keys", "_t" ], - "properties": { - "_t": { - "enum": [ - "DemographicSelection" - ], - "type": "string" - }, - "keys": { - "type": "array", - "items": { - "type": "string" - } + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IPairMakerConfigFullPermutationPairMakerConfig" }, - "maxRapids": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IPairMakerConfigOnlinePairMakerConfig" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "FullPermutationPairMaker": "#/components/schemas/IPairMakerConfigFullPermutationPairMakerConfig", + "OnlinePairMaker": "#/components/schemas/IPairMakerConfigOnlinePairMakerConfig" } } }, - "ISelectionEffortCappedSelection": { + "IPairMakerConfigFullPermutationPairMakerConfig": { "required": [ - "effortBudget", "_t" ], "properties": { "_t": { "enum": [ - "EffortCappedSelection" + "FullPermutationPairMaker" ], "type": "string" - }, - "effortBudget": { - "type": "integer", - "format": "int32" - }, - "retrievalMode": { - "$ref": "#/components/schemas/RetrievalMode" - }, - "maxIterations": { - "type": "integer", - "format": "int32", - "nullable": true } } }, - "ISelectionLabelingSelection": { + "IPairMakerConfigOnlinePairMakerConfig": { "required": [ "_t" ], "properties": { "_t": { "enum": [ - "LabelingSelection" + "OnlinePairMaker" ], "type": "string" }, - "amount": { - "type": "integer", - "format": "int32", - "nullable": true + "randomMatchesRatio": { + "type": "number", + "format": "float" }, - "effortBudget": { + "totalComparisonBudget": { "type": "integer", "format": "int32" - }, - "retrievalMode": { - "$ref": "#/components/schemas/RetrievalMode" - }, - "maxIterations": { - "type": "integer", - "format": "int32", - "nullable": true } } }, - "ISelectionShufflingSelection": { + "IPairMakerInformation": { "required": [ - "selections", "_t" ], - "properties": { - "_t": { - "enum": [ - "ShufflingSelection" - ], - "type": "string" + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IPairMakerInformationFullPermutationPairMakerInformation" }, - "selections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ISelection" - } + { + "$ref": "#/components/schemas/IPairMakerInformationOnlinePairMakerInformation" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "FullPermutationPairMakerInformation": "#/components/schemas/IPairMakerInformationFullPermutationPairMakerInformation", + "OnlinePairMakerInformation": "#/components/schemas/IPairMakerInformationOnlinePairMakerInformation" } } }, - "ISelectionStaticSelection": { + "IPairMakerInformationFullPermutationPairMakerInformation": { "required": [ - "rapidIds", "_t" ], "properties": { "_t": { "enum": [ - "StaticSelection" + "FullPermutationPairMakerInformation" ], "type": "string" - }, - "rapidIds": { - "type": "array", - "items": { - "type": "string" - } } } }, - "ISelectionValidationSelection": { + "IPairMakerInformationOnlinePairMakerInformation": { "required": [ - "amount", - "validationSetId", + "randomMatchesRatio", + "totalComparisonBudget", + "currentComparisonBudget", "_t" ], "properties": { "_t": { "enum": [ - "ValidationSelection" + "OnlinePairMakerInformation" ], "type": "string" }, - "amount": { + "randomMatchesRatio": { + "type": "number", + "format": "float" + }, + "totalComparisonBudget": { "type": "integer", "format": "int32" }, - "validationSetId": { - "type": "string" + "currentComparisonBudget": { + "type": "integer", + "format": "int32" } } }, - "IUserFilter": { + "IPipeline": { "required": [ "_t" ], "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/IUserFilterAgeUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterAndUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterCampaignUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterCountryUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterCustomUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterDeviceUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterGenderUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterLanguageUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterNewUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterNotUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterOrUserFilter" - }, - { - "$ref": "#/components/schemas/IUserFilterResponseCountUserFilter" - }, + "$ref": "#/components/schemas/IPipelineCreateSimplePipeline" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "CreateSimplePipelineModel": "#/components/schemas/IPipelineCreateSimplePipeline" + } + } + }, + "IPipelineArtifact": { + "required": [ + "_t" + ], + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/IUserFilterUserScoreUserFilter" + "$ref": "#/components/schemas/IPipelineArtifactCreateDatasetArtifact" } ], "discriminator": { "propertyName": "_t", "mapping": { - "AgeFilter": "#/components/schemas/IUserFilterAgeUserFilter", - "AndFilter": "#/components/schemas/IUserFilterAndUserFilter", - "CampaignFilter": "#/components/schemas/IUserFilterCampaignUserFilter", - "CountryFilter": "#/components/schemas/IUserFilterCountryUserFilter", - "CustomFilter": "#/components/schemas/IUserFilterCustomUserFilter", - "DeviceFilter": "#/components/schemas/IUserFilterDeviceUserFilter", - "GenderFilter": "#/components/schemas/IUserFilterGenderUserFilter", - "LanguageFilter": "#/components/schemas/IUserFilterLanguageUserFilter", - "NewUserFilter": "#/components/schemas/IUserFilterNewUserFilter", - "NotFilter": "#/components/schemas/IUserFilterNotUserFilter", - "OrFilter": "#/components/schemas/IUserFilterOrUserFilter", - "ResponseCountFilter": "#/components/schemas/IUserFilterResponseCountUserFilter", - "UserScoreFilter": "#/components/schemas/IUserFilterUserScoreUserFilter" + "CreateDatasetArtifactModel": "#/components/schemas/IPipelineArtifactCreateDatasetArtifact" } } }, - "IUserFilterAgeUserFilter": { + "IPipelineArtifactCreateDatasetArtifact": { "required": [ - "ageGroups", + "identifier", + "dataset", "_t" ], "properties": { "_t": { "enum": [ - "AgeFilter" + "CreateDatasetArtifactModel" ], "type": "string" }, - "ageGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AgeUserFilter_AgeGroup" - } + "identifier": { + "type": "string" + }, + "dataset": { + "$ref": "#/components/schemas/IDataset" } } }, - "IUserFilterAndUserFilter": { + "IPipelineCreateSimplePipeline": { "required": [ - "filters", + "artifacts", + "pipelineSteps", + "namePrefix", "_t" ], "properties": { "_t": { "enum": [ - "AndFilter" + "CreateSimplePipelineModel" ], "type": "string" }, - "filters": { + "artifacts": { "type": "array", "items": { - "$ref": "#/components/schemas/IUserFilter" + "$ref": "#/components/schemas/IPipelineArtifact" + } + }, + "pipelineSteps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IPipelineStep" } + }, + "namePrefix": { + "type": "string" } } }, - "IUserFilterCampaignUserFilter": { + "IPipelineStep": { "required": [ - "campaignIds", + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IPipelineStepDatasetEvaluationStep" + }, + { + "$ref": "#/components/schemas/IPipelineStepSendCompletionMailStep" + }, + { + "$ref": "#/components/schemas/IPipelineStepWorkflowAggregationStep" + }, + { + "$ref": "#/components/schemas/IPipelineStepWorkflowLabelingStep" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "DatasetEvaluationStepModel": "#/components/schemas/IPipelineStepDatasetEvaluationStep", + "SendCompletionMailStepModel": "#/components/schemas/IPipelineStepSendCompletionMailStep", + "WorkflowAggregationStepModel": "#/components/schemas/IPipelineStepWorkflowAggregationStep", + "WorkflowLabelingStepModel": "#/components/schemas/IPipelineStepWorkflowLabelingStep" + } + } + }, + "IPipelineStepDatasetEvaluationStep": { + "required": [ + "datasetArtifactId", + "aggregationResultFileArtifactId", + "evaluationResultFileArtifactId", + "receiver", "_t" ], "properties": { "_t": { "enum": [ - "CampaignFilter" + "DatasetEvaluationStepModel" ], "type": "string" }, - "campaignIds": { - "type": "array", - "items": { - "type": "string" - } + "datasetArtifactId": { + "type": "string" + }, + "aggregationResultFileArtifactId": { + "type": "string" + }, + "evaluationResultFileArtifactId": { + "type": "string" + }, + "receiver": { + "type": "string" } } }, - "IUserFilterCountryUserFilter": { + "IPipelineStepSendCompletionMailStep": { "required": [ - "countries", + "receiver", + "resultsFileArtifactIdentifier", "_t" ], "properties": { "_t": { "enum": [ - "CountryFilter" + "SendCompletionMailStepModel" ], "type": "string" }, - "countries": { - "type": "array", - "items": { - "type": "string" - } + "receiver": { + "type": "string" + }, + "resultsFileArtifactIdentifier": { + "type": "string" } } }, - "IUserFilterCustomUserFilter": { + "IPipelineStepWorkflowAggregationStep": { "required": [ - "identifier", - "values", + "campaignArtifactId", + "workflowArtifactId", + "fileArtifactId", "_t" ], "properties": { "_t": { "enum": [ - "CustomFilter" + "WorkflowAggregationStepModel" ], "type": "string" }, - "identifier": { + "campaignArtifactId": { "type": "string" }, - "values": { + "workflowArtifactId": { + "type": "string" + }, + "fileArtifactId": { + "type": "string" + }, + "aggregatorType": { + "$ref": "#/components/schemas/AggregatorType" + }, + "demographicKeys": { "type": "array", "items": { "type": "string" - } + }, + "nullable": true } } }, - "IUserFilterDeviceUserFilter": { + "IPipelineStepWorkflowLabelingStep": { "required": [ - "deviceTypes", + "workflowArtifactId", "_t" ], "properties": { "_t": { "enum": [ - "DeviceFilter" + "WorkflowLabelingStepModel" ], "type": "string" }, - "deviceTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeviceType" - } + "workflowArtifactId": { + "type": "string" } } }, - "IUserFilterGenderUserFilter": { + "IRankingConfig": { "required": [ - "genders", "_t" ], - "properties": { - "_t": { - "enum": [ - "GenderFilter" - ], - "type": "string" + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IRankingConfigBradleyTerryRankingConfig" }, - "genders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GenderUserFilter_Gender" - } + { + "$ref": "#/components/schemas/IRankingConfigEloConfig" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "BradleyTerryRankingConfig": "#/components/schemas/IRankingConfigBradleyTerryRankingConfig", + "EloConfig": "#/components/schemas/IRankingConfigEloConfig" } } }, - "IUserFilterLanguageUserFilter": { + "IRankingConfigBradleyTerryRankingConfig": { "required": [ - "languages", + "startingScore", "_t" ], "properties": { "_t": { "enum": [ - "LanguageFilter" + "BradleyTerryRankingConfig" ], "type": "string" }, - "languages": { - "type": "array", - "items": { - "type": "string" - } + "startingScore": { + "type": "integer", + "format": "int32" } } }, - "IUserFilterNewUserFilter": { + "IRankingConfigEloConfig": { "required": [ + "startingScore", + "kFactor", + "scalingFactor", "_t" ], "properties": { "_t": { "enum": [ - "NewUserFilter" + "EloConfig" ], "type": "string" + }, + "startingScore": { + "type": "integer", + "format": "int32" + }, + "kFactor": { + "type": "integer", + "format": "int32" + }, + "scalingFactor": { + "type": "integer", + "format": "int32" } } }, - "IUserFilterNotUserFilter": { + "IRapidBlueprint": { "required": [ - "filter", + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IRapidBlueprintAttachCategoryRapidBlueprint" + }, + { + "$ref": "#/components/schemas/IRapidBlueprintBoundingBoxRapidBlueprint" + }, + { + "$ref": "#/components/schemas/IRapidBlueprintCompareRapidBlueprint" + }, + { + "$ref": "#/components/schemas/IRapidBlueprintFreeTextRapidBlueprint" + }, + { + "$ref": "#/components/schemas/IRapidBlueprintLineRapidBlueprint" + }, + { + "$ref": "#/components/schemas/IRapidBlueprintLocateRapidBlueprint" + }, + { + "$ref": "#/components/schemas/IRapidBlueprintNamedEntityRapidBlueprint" + }, + { + "$ref": "#/components/schemas/IRapidBlueprintPolygonRapidBlueprint" + }, + { + "$ref": "#/components/schemas/IRapidBlueprintScrubRapidBlueprint" + }, + { + "$ref": "#/components/schemas/IRapidBlueprintTranscriptionRapidBlueprint" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "ClassifyBlueprint": "#/components/schemas/IRapidBlueprintAttachCategoryRapidBlueprint", + "BoundingBoxBlueprint": "#/components/schemas/IRapidBlueprintBoundingBoxRapidBlueprint", + "CompareBlueprint": "#/components/schemas/IRapidBlueprintCompareRapidBlueprint", + "FreeTextBlueprint": "#/components/schemas/IRapidBlueprintFreeTextRapidBlueprint", + "LineBlueprint": "#/components/schemas/IRapidBlueprintLineRapidBlueprint", + "LocateBlueprint": "#/components/schemas/IRapidBlueprintLocateRapidBlueprint", + "NamedEntityBlueprint": "#/components/schemas/IRapidBlueprintNamedEntityRapidBlueprint", + "PolygonBlueprint": "#/components/schemas/IRapidBlueprintPolygonRapidBlueprint", + "ScrubBlueprint": "#/components/schemas/IRapidBlueprintScrubRapidBlueprint", + "TranscriptionBlueprint": "#/components/schemas/IRapidBlueprintTranscriptionRapidBlueprint" + } + } + }, + "IRapidBlueprintAttachCategoryRapidBlueprint": { + "required": [ + "categories", + "title", "_t" ], "properties": { "_t": { "enum": [ - "NotFilter" + "ClassifyBlueprint" ], "type": "string" }, - "filter": { - "$ref": "#/components/schemas/IUserFilter" + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttachCategoryRapidBlueprint_Category" + } + }, + "possibleCategories": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "title": { + "type": "string" } } }, - "IUserFilterOrUserFilter": { + "IRapidBlueprintBoundingBoxRapidBlueprint": { "required": [ - "filters", + "target", "_t" ], "properties": { "_t": { "enum": [ - "OrFilter" + "BoundingBoxBlueprint" ], "type": "string" }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IUserFilter" - } + "target": { + "type": "string" } } }, - "IUserFilterResponseCountUserFilter": { + "IRapidBlueprintCompareRapidBlueprint": { "required": [ - "responseCount", - "dimension", - "operator", + "criteria", "_t" ], "properties": { "_t": { "enum": [ - "ResponseCountFilter" + "CompareBlueprint" ], "type": "string" }, - "responseCount": { - "type": "integer", - "format": "uint32" - }, - "dimension": { + "criteria": { "type": "string" }, - "operator": { - "$ref": "#/components/schemas/ComparisonOperator" + "indexIdentifiers": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } } }, - "IUserFilterUserScoreUserFilter": { + "IRapidBlueprintFreeTextRapidBlueprint": { "required": [ + "question", "_t" ], "properties": { "_t": { "enum": [ - "UserScoreFilter" + "FreeTextBlueprint" ], "type": "string" }, - "lowerbound": { - "type": "number", - "format": "double" + "question": { + "type": "string" }, - "upperbound": { - "type": "number", - "format": "double" + "shouldValidateResponse": { + "type": "boolean", + "nullable": true }, - "dimension": { + "validationSystemPrompt": { "type": "string", "nullable": true } } }, - "JobDefinitionRevisionState": { - "enum": [ - "Pending", - "Completed", - "Failed" - ] - }, - "JobNavigationItem": { + "IRapidBlueprintLineRapidBlueprint": { "required": [ - "rapidId", - "asset", - "state" + "target", + "_t" ], - "type": "object", "properties": { - "rapidId": { + "_t": { + "enum": [ + "LineBlueprint" + ], "type": "string" }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "state": { - "$ref": "#/components/schemas/RapidState" + "target": { + "type": "string" } } }, - "JobRapidResult": { + "IRapidBlueprintLocateRapidBlueprint": { "required": [ - "rapidId", - "asset", - "responses", - "totalResponseCount", - "state", - "payload" + "target", + "_t" ], - "type": "object", "properties": { - "rapidId": { - "type": "string" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "responses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JobResponse" - } - }, - "totalResponseCount": { - "type": "integer", - "format": "int64" - }, - "state": { - "$ref": "#/components/schemas/RapidState" - }, - "payload": { - "$ref": "#/components/schemas/IRapidPayload" - }, - "context": { - "type": "string", - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } + "_t": { + "enum": [ + "LocateBlueprint" ], - "nullable": true - }, - "decisiveness": { - "type": "number", - "format": "double", - "nullable": true + "type": "string" }, - "aggregation": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IResponseAggregation" - } - ], - "nullable": true + "target": { + "type": "string" } } }, - "JobResponse": { + "IRapidBlueprintNamedEntityRapidBlueprint": { "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "result", - "userScore", - "userScores", - "demographicInformation" + "target", + "classes", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { + "_t": { + "enum": [ + "NamedEntityBlueprint" + ], "type": "string" }, - "language": { + "target": { "type": "string" }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { - "type": "string", - "nullable": true - }, - "occupation": { - "type": "string", - "nullable": true - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "LabelingState": { - "enum": [ - "Created", - "Started", - "Labeling", - "Paused", - "Done", - "Failed" - ] - }, - "LineResult_Line": { - "required": [ - "size", - "points" - ], - "type": "object", - "properties": { - "size": { - "type": "number", - "format": "double" - }, - "points": { + "classes": { "type": "array", "items": { - "$ref": "#/components/schemas/LineResult_LinePoint" + "type": "string" } } } }, - "LineResult_LinePoint": { - "required": [ - "x", - "y" - ], - "type": "object", - "properties": { - "x": { - "type": "number", - "format": "double" - }, - "y": { - "type": "number", - "format": "double" - } - } - }, - "LocateCoordinate": { - "required": [ - "x", - "y" - ], - "type": "object", - "properties": { - "x": { - "type": "number", - "format": "double" - }, - "y": { - "type": "number", - "format": "double" - } - } - }, - "NamedEntityResult_NamedClassification": { + "IRapidBlueprintPolygonRapidBlueprint": { "required": [ - "start", - "end", - "classification" + "target", + "_t" ], - "type": "object", "properties": { - "start": { - "type": "integer", - "format": "int32" - }, - "end": { - "type": "integer", - "format": "int32" + "_t": { + "enum": [ + "PolygonBlueprint" + ], + "type": "string" }, - "classification": { + "target": { "type": "string" } } }, - "OrderState": { - "enum": [ - "Created", - "Preview", - "Submitted", - "ManualReview", - "Queued", - "Processing", - "Paused", - "Completed", - "Cancelled", - "Failed", - "StaleResults" - ] - }, - "PolygonResult_Coordinate": { + "IRapidBlueprintScrubRapidBlueprint": { "required": [ - "x", - "y" + "target", + "_t" ], - "type": "object", "properties": { - "x": { - "type": "number", - "format": "double", - "nullable": true + "_t": { + "enum": [ + "ScrubBlueprint" + ], + "type": "string" }, - "y": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "PolygonResult_Shape": { - "required": [ - "edges" - ], - "type": "object", - "properties": { - "edges": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PolygonResult_Coordinate" - } - } - } - }, - "PreviewOrderEndpoint_Input": { - "type": "object", - "properties": { - "ignoreFailedDatapoints": { - "type": "boolean", - "description": "Whether the order should proceed even if certain datapoints failed.", - "nullable": true + "target": { + "type": "string" } } }, - "QueryAggregatedJobsEndpoint_Output": { + "IRapidBlueprintTranscriptionRapidBlueprint": { "required": [ - "amount", - "last7Days", - "lastJobDate", - "lastJobName", - "lastJobId", - "ownerMail", - "organizationId" + "title", + "_t" ], - "type": "object", "properties": { - "amount": { - "type": "integer", - "description": "The total number of jobs for this customer.", - "format": "int32" - }, - "last7Days": { - "type": "integer", - "description": "The number of jobs created in the last 7 days.", - "format": "int32" - }, - "lastJobDate": { - "type": "string", - "description": "The date of the most recent job.", - "format": "date-time" - }, - "lastJobName": { - "type": "string", - "description": "The name of the most recent job." - }, - "lastJobId": { - "type": "string", - "description": "The ID of the most recent job." - }, - "ownerMail": { - "type": "string", - "description": "The customer's email address." + "_t": { + "enum": [ + "TranscriptionBlueprint" + ], + "type": "string" }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." + "title": { + "type": "string" } } }, - "QueryAggregatedJobsEndpoint_PagedResultOfOutput": { + "IRapidPayload": { "required": [ - "total", - "page", - "pageSize", - "items" + "_t" ], "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" + "oneOf": [ + { + "$ref": "#/components/schemas/IRapidPayloadBoundingBoxPayload" }, - "page": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidPayloadClassifyPayload" }, - "pageSize": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidPayloadComparePayload" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryAggregatedJobsEndpoint_Output" - } + { + "$ref": "#/components/schemas/IRapidPayloadFreeTextPayload" }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "QueryAggregatedOrdersEndpoint_Output": { - "required": [ - "amount", - "last7Days", - "lastOrderDate", - "lastOrderName", - "lastOrderId", - "customerMail" - ], - "type": "object", - "properties": { - "amount": { - "type": "integer", - "description": "The total number of orders for this customer.", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidPayloadLinePayload" }, - "last7Days": { - "type": "integer", - "description": "The number of orders placed in the last 7 days.", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidPayloadLocatePayload" }, - "lastOrderDate": { - "type": "string", - "description": "The date of the most recent order.", - "format": "date-time" + { + "$ref": "#/components/schemas/IRapidPayloadNamedEntityPayload" }, - "lastOrderName": { - "type": "string", - "description": "The name of the most recent order." + { + "$ref": "#/components/schemas/IRapidPayloadPolygonPayload" }, - "lastOrderId": { - "type": "string", - "description": "The ID of the most recent order." + { + "$ref": "#/components/schemas/IRapidPayloadScrubPayload" }, - "customerMail": { - "type": "string", - "description": "The customer's email address." + { + "$ref": "#/components/schemas/IRapidPayloadTranscriptionPayload" } - } - }, - "QueryAggregatedOrdersEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryAggregatedOrdersEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" + "discriminator": { + "propertyName": "_t", + "mapping": { + "BoundingBoxPayload": "#/components/schemas/IRapidPayloadBoundingBoxPayload", + "ClassifyPayload": "#/components/schemas/IRapidPayloadClassifyPayload", + "ComparePayload": "#/components/schemas/IRapidPayloadComparePayload", + "FreeTextPayload": "#/components/schemas/IRapidPayloadFreeTextPayload", + "LinePayload": "#/components/schemas/IRapidPayloadLinePayload", + "LocatePayload": "#/components/schemas/IRapidPayloadLocatePayload", + "NamedEntityPayload": "#/components/schemas/IRapidPayloadNamedEntityPayload", + "PolygonPayload": "#/components/schemas/IRapidPayloadPolygonPayload", + "ScrubPayload": "#/components/schemas/IRapidPayloadScrubPayload", + "TranscriptionPayload": "#/components/schemas/IRapidPayloadTranscriptionPayload" } } }, - "QueryJobDefinitionsEndpoint_Output": { + "IRapidPayloadBoundingBoxPayload": { "required": [ - "definitionId", - "name", - "definitionType", - "createdAt", - "revisionCount", - "ownerId", - "ownerMail", - "organizationId" + "target", + "_t" ], - "type": "object", "properties": { - "definitionId": { - "type": "string", - "description": "The id of the job definition." - }, - "name": { - "type": "string", - "description": "The name of the job definition." - }, - "definitionType": { - "allOf": [ - { - "$ref": "#/components/schemas/DefinitionType" - } + "_t": { + "enum": [ + "BoundingBoxPayload" ], - "description": "The type of the job definition." - }, - "createdAt": { - "type": "string", - "description": "The creation timestamp of the job definition.", - "format": "date-time" - }, - "revisionCount": { - "type": "integer", - "description": "The number of revisions for this job definition.", - "format": "int32" - }, - "ownerId": { - "type": "string", - "description": "The id of the owner of the job definition.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The email of the owner of the job definition." + "type": "string" }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." + "target": { + "type": "string" } } }, - "QueryJobDefinitionsEndpoint_PagedResultOfOutput": { + "IRapidPayloadClassifyPayload": { "required": [ - "total", - "page", - "pageSize", - "items" + "categories", + "title", + "_t" ], - "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" + "_t": { + "enum": [ + "ClassifyPayload" + ], + "type": "string" }, - "items": { + "categories": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryJobDefinitionsEndpoint_Output" + "$ref": "#/components/schemas/ClassifyPayload_Category" } }, - "totalPages": { - "type": "integer", - "format": "int32" + "title": { + "type": "string" } } }, - "QueryJobRevisionsEndpoint_Output": { + "IRapidPayloadComparePayload": { "required": [ - "definitionId", - "revisionNumber", - "createdAt", - "state" + "criteria", + "_t" ], - "type": "object", "properties": { - "definitionId": { - "type": "string", - "description": "The id of the job definition this revision belongs to." - }, - "revisionNumber": { - "type": "integer", - "description": "The revision number.", - "format": "int32" - }, - "createdAt": { - "type": "string", - "description": "The timestamp when this revision was created.", - "format": "date-time" - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/JobDefinitionRevisionState" - } + "_t": { + "enum": [ + "ComparePayload" ], - "description": "The current state of the revision." + "type": "string" + }, + "criteria": { + "type": "string" } } }, - "QueryJobRevisionsEndpoint_PagedResultOfOutput": { + "IRapidPayloadFreeTextPayload": { "required": [ - "total", - "page", - "pageSize", - "items" + "question", + "_t" ], - "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" + "_t": { + "enum": [ + "FreeTextPayload" + ], + "type": "string" }, - "pageSize": { - "type": "integer", - "format": "int32" + "question": { + "type": "string" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryJobRevisionsEndpoint_Output" - } + "shouldValidateResponse": { + "type": "boolean" }, - "totalPages": { - "type": "integer", - "format": "int32" + "validationSystemPrompt": { + "type": "string", + "nullable": true } } }, - "QueryJobsEndpoint_Output": { + "IRapidPayloadLinePayload": { "required": [ - "jobId", - "name", - "jobDefinitionId", - "audienceId", - "revisionNumber", - "pipelineId", - "state", - "ownerMail", - "organizationId", - "createdAt" + "target", + "_t" ], - "type": "object", "properties": { - "jobId": { - "type": "string", - "description": "The id of the job." - }, - "name": { - "type": "string", - "description": "The name of the job." - }, - "definitionId": { - "type": "string", - "description": "The id of the job definition.", - "nullable": true, - "deprecated": true - }, - "jobDefinitionId": { - "type": "string", - "description": "The id of the job definition." - }, - "audienceId": { - "type": "string", - "description": "The id of the audience associated with the job." - }, - "revisionNumber": { - "type": "integer", - "description": "The revision number of the job.", - "format": "int32" - }, - "pipelineId": { - "type": "string", - "description": "The id of the pipeline executing the job." - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceJobState" - } + "_t": { + "enum": [ + "LinePayload" ], - "description": "The current state of the job.", - "deprecated": true + "type": "string" }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/AudienceJobState" - } + "target": { + "type": "string" + } + } + }, + "IRapidPayloadLocatePayload": { + "required": [ + "target", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "LocatePayload" ], - "description": "The current state of the job." - }, - "ownerMail": { - "type": "string", - "description": "The email of the job's owner." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - }, - "createdAt": { - "type": "string", - "description": "The timestamp when the job was created.", - "format": "date-time" + "type": "string" }, - "progress": { - "type": "number", - "description": "Labeling completion as a ratio in the range 0–1, or null when no progress has\n been reported yet (completion sets it to 1). Sortable via ?sort=progress.", - "format": "double", - "nullable": true + "target": { + "type": "string" } } }, - "QueryJobsEndpoint_PagedResultOfOutput": { + "IRapidPayloadNamedEntityPayload": { "required": [ - "total", - "page", - "pageSize", - "items" + "target", + "classes", + "_t" ], - "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" + "_t": { + "enum": [ + "NamedEntityPayload" + ], + "type": "string" }, - "pageSize": { - "type": "integer", - "format": "int32" + "target": { + "type": "string" }, - "items": { + "classes": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryJobsEndpoint_Output" + "type": "string" } - }, - "totalPages": { - "type": "integer", - "format": "int32" } } }, - "QueryOrdersEndpoint_Output": { + "IRapidPayloadPolygonPayload": { "required": [ - "id", - "pipelineId", - "orderDate", - "customerMail", - "state", - "orderName", - "isPublic" + "target", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the order." - }, - "pipelineId": { - "type": "string", - "description": "The ID of the pipeline associated with the order." - }, - "orderDate": { - "type": "string", - "description": "The date the order was placed.", - "format": "date-time", - "nullable": true - }, - "customerMail": { - "type": "string", - "description": "The email of the customer who placed the order." - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/OrderState" - } + "_t": { + "enum": [ + "PolygonPayload" ], - "description": "The current state of the order." - }, - "orderName": { - "type": "string", - "description": "The name of the order." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the order is publicly visible." + "type": "string" }, - "failureMessage": { - "type": "string", - "description": "The failure message if the order failed.", - "nullable": true + "target": { + "type": "string" } } }, - "QueryOrdersEndpoint_PagedResultOfOutput": { + "IRapidPayloadScrubPayload": { "required": [ - "total", - "page", - "pageSize", - "items" + "target", + "_t" ], - "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" + "_t": { + "enum": [ + "ScrubPayload" + ], + "type": "string" }, - "page": { - "type": "integer", - "format": "int32" + "target": { + "type": "string" + } + } + }, + "IRapidPayloadTranscriptionPayload": { + "required": [ + "title", + "transcription", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "TranscriptionPayload" + ], + "type": "string" }, - "pageSize": { - "type": "integer", - "format": "int32" + "title": { + "type": "string" }, - "items": { + "transcription": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryOrdersEndpoint_Output" + "$ref": "#/components/schemas/TranscriptionPayload_TranscriptionWord" } - }, - "totalPages": { - "type": "integer", - "format": "int32" } } }, - "QueryPublicJobDefinitionsEndpoint_Output": { + "IRapidResult": { "required": [ - "definitionId", - "name", - "definitionType", - "createdAt", - "revisionCount", - "ownerId", - "ownerMail", - "organizationId" + "_t" ], "type": "object", - "properties": { - "definitionId": { - "type": "string", - "description": "The id of the job definition." - }, - "name": { - "type": "string", - "description": "The name of the job definition." + "oneOf": [ + { + "$ref": "#/components/schemas/IRapidResultAttachCategoryResult" }, - "definitionType": { - "allOf": [ - { - "$ref": "#/components/schemas/DefinitionType" - } - ], - "description": "The type of the job definition." + { + "$ref": "#/components/schemas/IRapidResultBoundingBoxResult" }, - "createdAt": { - "type": "string", - "description": "The creation timestamp of the job definition.", - "format": "date-time" + { + "$ref": "#/components/schemas/IRapidResultCompareResult" }, - "revisionCount": { - "type": "integer", - "description": "The number of revisions for this job definition.", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidResultFreeTextResult" }, - "ownerId": { - "type": "string", - "description": "The id of the owner of the job definition.", - "format": "uuid" + { + "$ref": "#/components/schemas/IRapidResultLineResult" }, - "ownerMail": { - "type": "string", - "description": "The email of the owner of the job definition." + { + "$ref": "#/components/schemas/IRapidResultLocateResult" }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - } - } - }, - "QueryPublicJobDefinitionsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" + { + "$ref": "#/components/schemas/IRapidResultNamedEntityResult" }, - "page": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidResultPolygonResult" }, - "pageSize": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidResultScrubResult" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryPublicJobDefinitionsEndpoint_Output" - } + { + "$ref": "#/components/schemas/IRapidResultSkipResult" }, - "totalPages": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidResultTranscriptionResult" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AttachCategoryResult": "#/components/schemas/IRapidResultAttachCategoryResult", + "BoundingBoxResult": "#/components/schemas/IRapidResultBoundingBoxResult", + "CompareResult": "#/components/schemas/IRapidResultCompareResult", + "FreeTextResult": "#/components/schemas/IRapidResultFreeTextResult", + "LineResult": "#/components/schemas/IRapidResultLineResult", + "LocateResult": "#/components/schemas/IRapidResultLocateResult", + "NamedEntityResult": "#/components/schemas/IRapidResultNamedEntityResult", + "PolygonResult": "#/components/schemas/IRapidResultPolygonResult", + "ScrubResult": "#/components/schemas/IRapidResultScrubResult", + "SkipResult": "#/components/schemas/IRapidResultSkipResult", + "TranscriptionResult": "#/components/schemas/IRapidResultTranscriptionResult" } } }, - "RankingDatapoint": { + "IRapidResultAttachCategoryResult": { "required": [ - "datapointId", - "asset", - "elo" + "rapidId", + "category", + "_t" ], - "type": "object", "properties": { - "datapointId": { + "_t": { + "enum": [ + "AttachCategoryResult" + ], "type": "string" }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "rapidId": { + "type": "string" }, - "elo": { - "type": "integer", - "format": "int32" + "category": { + "type": "string" } } }, - "RapidState": { - "enum": [ - "Labeling", - "Paused", - "Incomplete", - "Flagged", - "Done", - "None", - "Rejected" - ] - }, - "ResponseTally": { + "IRapidResultBoundingBoxResult": { "required": [ - "count", - "userScoreSum" + "rapidId", + "boundingBoxes", + "_t" ], - "type": "object", "properties": { - "count": { - "type": "integer", - "format": "int64" + "_t": { + "enum": [ + "BoundingBoxResult" + ], + "type": "string" }, - "userScoreSum": { - "type": "number", - "format": "double" + "rapidId": { + "type": "string" + }, + "boundingBoxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BoundingBoxResult_Box" + } } } }, - "RestartRapidsEndpoint_Input": { + "IRapidResultCompareResult": { "required": [ - "rapidIds" + "rapidId", + "_t" ], - "type": "object", "properties": { - "rapidIds": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } + "_t": { + "enum": [ + "CompareResult" ], - "description": "The ids of the rapids to restart." + "type": "string" + }, + "rapidId": { + "type": "string" + }, + "winners": { + "type": "array", + "items": { + "type": "string" + } } - }, - "description": "The input for the restart rapids endpoint." - }, - "ReviewReason": { - "enum": [ - "ContentFlagged", - "UnsupportedContentType", - "CheckErrored", - "ClassificationTimedOut", - null - ] - }, - "SortDirection": { - "enum": [ - "Asc", - "Desc" - ] - }, - "StickyState": { - "enum": [ - "None", - "Temporary", - "Permanent", - "Passive", - null - ] + } }, - "SubmitFeedbackEndpoint_Input": { + "IRapidResultFreeTextResult": { "required": [ - "feedback" + "rapidId", + "answer", + "_t" ], - "type": "object", "properties": { - "feedback": { - "type": "string", - "description": "The feedback text." + "_t": { + "enum": [ + "FreeTextResult" + ], + "type": "string" }, - "email": { - "type": "string", - "description": "The email of the user submitting the feedback.", - "nullable": true + "rapidId": { + "type": "string" }, - "token": { - "type": "string", - "description": "The recaptcha token, required when the caller is not authenticated.", - "nullable": true - } - } - }, - "SubmitOrderEndpoint_Input": { - "type": "object", - "properties": { - "ignoreFailedDatapoints": { - "type": "boolean", - "description": "Whether the order should proceed even if certain datapoints failed.", - "nullable": true + "answer": { + "type": "string" } } }, - "TranscriptionPayload_TranscriptionWord": { + "IRapidResultLineResult": { "required": [ - "word", - "wordIndex" + "rapidId", + "lines", + "_t" ], - "type": "object", "properties": { - "word": { + "_t": { + "enum": [ + "LineResult" + ], "type": "string" }, - "wordIndex": { - "type": "integer", - "format": "int32" + "rapidId": { + "type": "string" + }, + "lines": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineResult_Line" + } } } }, - "TranscriptionResult_TranscriptionWord": { + "IRapidResultLocateResult": { "required": [ - "word", - "wordIndex" + "rapidId", + "coordinates", + "_t" ], - "type": "object", "properties": { - "word": { + "_t": { + "enum": [ + "LocateResult" + ], "type": "string" }, - "wordIndex": { - "type": "integer", - "format": "int32" + "rapidId": { + "type": "string" + }, + "coordinates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocateCoordinate" + } } } }, - "UnlockOrderEndpoint_Output": { + "IRapidResultNamedEntityResult": { "required": [ - "datasetIds" + "rapidId", + "classifications", + "_t" ], - "type": "object", "properties": { - "datasetIds": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - } + "_t": { + "enum": [ + "NamedEntityResult" ], - "description": "The dataset IDs created by unlocking the order." - } - } - }, - "UpdateJobDefinitionEndpoint_Input": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The new name for the job definition." - } - }, - "description": "The input for the update job definition endpoint." - }, - "UpdateJobEndpoint_Input": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The new name for the job." - } - }, - "description": "The input for the update job endpoint." - }, - "UpdateOrderEndpoint_Input": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The new name of the order, if specified." + "type": "string" }, - "precedingOrderId": { - "type": "string", - "description": "The ID of the order that must complete before this order starts processing.\n Set to null to clear an existing preceding order.", - "nullable": true + "rapidId": { + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NamedEntityResult_NamedClassification" + } } } }, - "BillingPeriodStatus": { - "enum": [ - "Open", - "Invoiced", - "Void", - "Reconciling", - "PendingReview", - "Closed" - ] - }, - "BillingSummaryMode": { - "enum": [ - "Usage", - "Limited", - "Prepaid" - ] - }, - "BulkBillingPeriodCloseState": { - "enum": [ - "Sweeping", - "Completed", - "Failed" - ] - }, - "BulkCloseBillingPeriodsEndpoint_Input": { + "IRapidResultPolygonResult": { "required": [ - "endedBefore", - "reason" + "rapidId", + "shapes", + "_t" ], - "type": "object", "properties": { - "endedBefore": { - "type": "string", - "description": "Only periods that ended before this date are closed.", - "format": "date-time" - }, - "maxNetInvoiceableAmount": { - "type": "number", - "description": "When set, only periods with at most this much left to invoice are closed, and a period whose\n amount has grown past it since it was last settled is refused.", - "format": "double", - "nullable": true + "_t": { + "enum": [ + "PolygonResult" + ], + "type": "string" }, - "reason": { - "type": "string", - "description": "Why the remaining amounts will never be invoiced." + "rapidId": { + "type": "string" }, - "dryRun": { - "type": "boolean", - "description": "Report what the sweep would write off without closing anything or minting any vouchers." + "shapes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolygonResult_Shape" + } } } }, - "BulkCloseBillingPeriodsEndpoint_Output": { + "IRapidResultScrubResult": { "required": [ - "bulkCloseId", - "dryRun" + "rapidId", + "timestamps", + "_t" ], - "type": "object", "properties": { - "bulkCloseId": { - "type": "string", - "description": "The run to poll for the sweep's progress." + "_t": { + "enum": [ + "ScrubResult" + ], + "type": "string" }, - "dryRun": { - "type": "boolean", - "description": "Whether this run only reports what it would have written off." + "rapidId": { + "type": "string" + }, + "timestamps": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } } } }, - "BulkReconciliationDispatchState": { - "enum": [ - "Dispatching", - "Completed", - "Failed" - ] - }, - "CloseBillingPeriodEndpoint_Input": { + "IRapidResultSkipResult": { "required": [ - "reason" + "rapidId", + "_t" ], - "type": "object", "properties": { - "reason": { - "type": "string", - "description": "Why the remaining amount will never be invoiced." + "_t": { + "enum": [ + "SkipResult" + ], + "type": "string" + }, + "rapidId": { + "type": "string" } } }, - "CloseBillingPeriodEndpoint_Output": { + "IRapidResultTranscriptionResult": { "required": [ - "billingPeriodId", - "writtenOffAmount" + "rapidId", + "selectedWords", + "_t" ], - "type": "object", "properties": { - "billingPeriodId": { - "type": "string", - "description": "The closed billing period." + "_t": { + "enum": [ + "TranscriptionResult" + ], + "type": "string" }, - "writtenOffAmount": { - "type": "number", - "description": "The amount that was written off.", - "format": "double" + "rapidId": { + "type": "string" }, - "writeOffVoucherId": { - "type": "string", - "description": "The voucher that absorbed the written-off amount, or null when there was nothing left.", - "nullable": true + "selectedWords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranscriptionResult_TranscriptionWord" + } } } }, - "CreateBillingItemBillingSettingEndpoint_Input": { + "IReferee": { + "required": [ + "_t" + ], "type": "object", - "properties": { - "priority": { - "type": "integer", - "description": "The priority of the setting. Defaults to the configured billing item default if not specified.", - "format": "int32", - "nullable": true - }, - "validFrom": { - "type": "string", - "description": "The start of the validity window.", - "format": "date-time", - "nullable": true - }, - "validTo": { - "type": "string", - "description": "The end of the validity window.", - "format": "date-time", - "nullable": true - }, - "costPerResponseFreeText": { - "type": "number", - "description": "The cost per free text response.", - "format": "double", - "nullable": true - }, - "costPerResponseImage": { - "type": "number", - "description": "The cost per image response.", - "format": "double", - "nullable": true - }, - "costPerResponseMediaPerSecond": { - "type": "number", - "description": "The cost per second of media response.", - "format": "double", - "nullable": true - }, - "costPerResponseMediaMinimum": { - "type": "number", - "description": "The minimum cost per media response.", - "format": "double", - "nullable": true - }, - "costPerResponseTextPer50Chars": { - "type": "number", - "description": "The cost per 50 characters of text response.", - "format": "double", - "nullable": true - }, - "costPerResponseContextTextPer50Chars": { - "type": "number", - "description": "The cost per 50 characters of context text.", - "format": "double", - "nullable": true - }, - "costPerResponseContextTextMinimum": { - "type": "number", - "description": "The minimum cost per context text.", - "format": "double", - "nullable": true - }, - "costPerResponseContextImage": { - "type": "number", - "description": "The cost per context image.", - "format": "double", - "nullable": true - }, - "costPerResponseContextVideoPerSecond": { - "type": "number", - "description": "The cost per second of context video.", - "format": "double", - "nullable": true + "oneOf": [ + { + "$ref": "#/components/schemas/IRefereeBudgetReferee" }, - "costPerResponseContextVideoMinimum": { - "type": "number", - "description": "The minimum cost per context video.", - "format": "double", - "nullable": true + { + "$ref": "#/components/schemas/IRefereeEarlyStoppingReferee" }, - "discountRatio": { - "type": "number", - "description": "The discount ratio (0-1, e.g. 0.10 = 10% off).", - "format": "double", - "nullable": true + { + "$ref": "#/components/schemas/IRefereeNaiveReferee" + }, + { + "$ref": "#/components/schemas/IRefereeQuorumReferee" } - }, - "description": "The billing setting input data." + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "BudgetReferee": "#/components/schemas/IRefereeBudgetReferee", + "EarlyStoppingReferee": "#/components/schemas/IRefereeEarlyStoppingReferee", + "NaiveReferee": "#/components/schemas/IRefereeNaiveReferee", + "QuorumReferee": "#/components/schemas/IRefereeQuorumReferee" + } + } }, - "CreateCheckoutEndpoint_Output": { + "IRefereeBudgetReferee": { "required": [ - "sessionId" + "totalBudget", + "_t" ], - "type": "object", "properties": { - "sessionId": { - "type": "string", - "description": "The id of the created checkout session." + "_t": { + "enum": [ + "BudgetReferee" + ], + "type": "string" + }, + "totalBudget": { + "type": "integer", + "format": "int32" } } }, - "CreateExternalServicePriceEndpoint_Input": { + "IRefereeEarlyStoppingReferee": { "required": [ - "serviceKind", - "pricingKey", - "unitPrice" + "maxVotes", + "threshold", + "_t" ], - "type": "object", "properties": { - "serviceKind": { - "allOf": [ - { - "$ref": "#/components/schemas/ExternalServiceKind" - } + "_t": { + "enum": [ + "EarlyStoppingReferee" ], - "description": "The service this price applies to." - }, - "pricingKey": { - "type": "string", - "description": "Hierarchical variant key (e.g. reve, replicate/flux-1.1-pro)." + "type": "string" }, - "customerId": { - "type": "string", - "description": "Null for the global default; set to scope the price to one customer.", - "format": "uuid", - "nullable": true + "maxVotes": { + "type": "integer", + "format": "int32" }, - "unitPrice": { + "threshold": { "type": "number", - "description": "Price per unit (per image / per shortening).", "format": "double" + } + } + }, + "IRefereeNaiveReferee": { + "required": [ + "totalVotes", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "NaiveReferee" + ], + "type": "string" }, - "priority": { + "totalVotes": { "type": "integer", - "description": "Priority; defaults to the configured global/customer default if unset.", - "format": "int32", - "nullable": true - }, - "validFrom": { - "type": "string", - "description": "The start of the validity window.", - "format": "date-time", - "nullable": true - }, - "validTo": { - "type": "string", - "description": "The end of the validity window.", - "format": "date-time", - "nullable": true + "format": "int32" } - }, - "description": "The external-service price input data." + } }, - "CreateGlobalBillingSettingEndpoint_Input": { - "type": "object", + "IRefereeQuorumReferee": { + "required": [ + "maxVotes", + "threshold", + "_t" + ], "properties": { - "priority": { - "type": "integer", - "description": "The priority of the setting. Defaults to the configured global default if not specified.", - "format": "int32", - "nullable": true - }, - "validFrom": { - "type": "string", - "description": "The start of the validity window.", - "format": "date-time", - "nullable": true - }, - "validTo": { - "type": "string", - "description": "The end of the validity window.", - "format": "date-time", - "nullable": true - }, - "costPerResponseFreeText": { - "type": "number", - "description": "The cost per free text response.", - "format": "double", - "nullable": true - }, - "costPerResponseImage": { - "type": "number", - "description": "The cost per image response.", - "format": "double", - "nullable": true - }, - "costPerResponseMediaPerSecond": { - "type": "number", - "description": "The cost per second of media response.", - "format": "double", - "nullable": true - }, - "costPerResponseMediaMinimum": { - "type": "number", - "description": "The minimum cost per media response.", - "format": "double", - "nullable": true - }, - "costPerResponseTextPer50Chars": { - "type": "number", - "description": "The cost per 50 characters of text response.", - "format": "double", - "nullable": true - }, - "costPerResponseContextTextPer50Chars": { - "type": "number", - "description": "The cost per 50 characters of context text.", - "format": "double", - "nullable": true - }, - "costPerResponseContextTextMinimum": { - "type": "number", - "description": "The minimum cost per context text.", - "format": "double", - "nullable": true - }, - "costPerResponseContextImage": { - "type": "number", - "description": "The cost per context image.", - "format": "double", - "nullable": true - }, - "costPerResponseContextVideoPerSecond": { - "type": "number", - "description": "The cost per second of context video.", - "format": "double", - "nullable": true + "_t": { + "enum": [ + "QuorumReferee" + ], + "type": "string" }, - "costPerResponseContextVideoMinimum": { - "type": "number", - "description": "The minimum cost per context video.", - "format": "double", - "nullable": true + "maxVotes": { + "type": "integer", + "format": "int32" }, - "discountRatio": { - "type": "number", - "description": "The discount ratio (0-1, e.g. 0.10 = 10% off).", - "format": "double", - "nullable": true + "threshold": { + "type": "integer", + "format": "int32" } - }, - "description": "The billing setting input data." + } }, - "CreateInvoiceEndpoint_Input": { + "IResponseAggregation": { "required": [ - "billingPeriodId" + "_t" ], "type": "object", - "properties": { - "billingPeriodId": { - "type": "string", - "description": "The billing period to create an invoice for." + "oneOf": [ + { + "$ref": "#/components/schemas/IResponseAggregationClassifyAggregation" + }, + { + "$ref": "#/components/schemas/IResponseAggregationCompareAggregation" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "ClassifyAggregation": "#/components/schemas/IResponseAggregationClassifyAggregation", + "CompareAggregation": "#/components/schemas/IResponseAggregationCompareAggregation" } } }, - "CreateInvoiceEndpoint_Output": { + "IResponseAggregationClassifyAggregation": { "required": [ - "invoiceId" + "categoryTallies", + "_t" ], - "type": "object", "properties": { - "invoiceId": { - "type": "string", - "description": "The created invoice ID." + "_t": { + "enum": [ + "ClassifyAggregation" + ], + "type": "string" + }, + "categoryTallies": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ResponseTally" + } } } }, - "CreateManualChargeEndpoint_Input": { + "IResponseAggregationCompareAggregation": { "required": [ - "name", - "billingPeriodId", - "organizationId", - "reason" + "winnerTallies", + "_t" ], - "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the manual charge." + "_t": { + "enum": [ + "CompareAggregation" + ], + "type": "string" }, - "billingPeriodId": { - "type": "string", - "description": "The billing period to add the charge to." + "winnerTallies": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ResponseTally" + } + } + } + }, + "ISelection": { + "required": [ + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ISelectionAbTestSelection" }, - "organizationId": { - "type": "string", - "description": "The organization the charge is billed to." + { + "$ref": "#/components/schemas/ISelectionCappedSelection" }, - "customerId": { - "type": "string", - "description": "The member the charge is recorded against, for auditability. Optional — omit it for a\n charge that belongs to the organization as a whole rather than to one of its members.", - "format": "uuid", - "nullable": true + { + "$ref": "#/components/schemas/ISelectionConditionalValidationSelection" }, - "customerMail": { - "type": "string", - "description": "The email address of the member named by CustomerId.", - "nullable": true + { + "$ref": "#/components/schemas/ISelectionDemographicSelection" }, - "amount": { - "type": "number", - "description": "The total charge amount, equivalent to a single unit priced at this value. Only\n honored when both Quantity and UnitPrice are omitted;\n never combine it with them.", - "format": "double", - "nullable": true, - "deprecated": true + { + "$ref": "#/components/schemas/ISelectionEffortCappedSelection" }, - "quantity": { - "type": "integer", - "description": "The number of units billed. The charge total is Quantity × UnitPrice, and the\n invoice line shows the unit breakdown.", - "format": "int32", - "nullable": true + { + "$ref": "#/components/schemas/ISelectionLabelingSelection" }, - "unitPrice": { - "type": "number", - "description": "The price per unit. Positive for fees, negative for refunds.", - "format": "double", - "nullable": true + { + "$ref": "#/components/schemas/ISelectionShufflingSelection" }, - "reason": { - "allOf": [ - { - "$ref": "#/components/schemas/ManualChargeReason" - } - ], - "description": "The reason for the manual charge." + { + "$ref": "#/components/schemas/ISelectionStaticSelection" }, - "comment": { - "type": "string", - "description": "An optional comment describing the charge.", - "nullable": true + { + "$ref": "#/components/schemas/ISelectionValidationSelection" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AbTestSelection": "#/components/schemas/ISelectionAbTestSelection", + "CappedSelection": "#/components/schemas/ISelectionCappedSelection", + "ConditionalValidationSelection": "#/components/schemas/ISelectionConditionalValidationSelection", + "DemographicSelection": "#/components/schemas/ISelectionDemographicSelection", + "EffortCappedSelection": "#/components/schemas/ISelectionEffortCappedSelection", + "LabelingSelection": "#/components/schemas/ISelectionLabelingSelection", + "ShufflingSelection": "#/components/schemas/ISelectionShufflingSelection", + "StaticSelection": "#/components/schemas/ISelectionStaticSelection", + "ValidationSelection": "#/components/schemas/ISelectionValidationSelection" } } }, - "CreateManualChargeEndpoint_Output": { + "ISelectionAbTestSelection": { "required": [ - "id" + "a", + "b", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The ID of the created billing item." + "_t": { + "enum": [ + "AbTestSelection" + ], + "type": "string" + }, + "a": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ISelection" + } + }, + "b": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ISelection" + } } } }, - "CreateOrganizationBillingSettingEndpoint_Input": { - "type": "object", + "ISelectionCappedSelection": { + "required": [ + "selections", + "maxRapids", + "_t" + ], "properties": { - "priority": { - "type": "integer", - "description": "The priority of the setting. Defaults to the configured organization default if not specified.", - "format": "int32", - "nullable": true - }, - "validFrom": { - "type": "string", - "description": "The start of the validity window.", - "format": "date-time", - "nullable": true - }, - "validTo": { - "type": "string", - "description": "The end of the validity window.", - "format": "date-time", - "nullable": true - }, - "costPerResponseFreeText": { - "type": "number", - "description": "The cost per free text response.", - "format": "double", - "nullable": true - }, - "costPerResponseImage": { - "type": "number", - "description": "The cost per image response.", - "format": "double", - "nullable": true - }, - "costPerResponseMediaPerSecond": { - "type": "number", - "description": "The cost per second of media response.", - "format": "double", - "nullable": true - }, - "costPerResponseMediaMinimum": { - "type": "number", - "description": "The minimum cost per media response.", - "format": "double", - "nullable": true + "_t": { + "enum": [ + "CappedSelection" + ], + "type": "string" }, - "costPerResponseTextPer50Chars": { - "type": "number", - "description": "The cost per 50 characters of text response.", - "format": "double", - "nullable": true + "selections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ISelection" + } }, - "costPerResponseContextTextPer50Chars": { - "type": "number", - "description": "The cost per 50 characters of context text.", - "format": "double", - "nullable": true + "maxRapids": { + "type": "integer", + "format": "int32" + } + } + }, + "ISelectionConditionalValidationSelection": { + "required": [ + "validationSetId", + "validationChances", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "ConditionalValidationSelection" + ], + "type": "string" }, - "costPerResponseContextTextMinimum": { - "type": "number", - "description": "The minimum cost per context text.", - "format": "double", - "nullable": true + "validationSetId": { + "type": "string" }, - "costPerResponseContextImage": { - "type": "number", - "description": "The cost per context image.", - "format": "double", - "nullable": true + "validationChances": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConditionalValidationSelection_ValidationChance" + } }, - "costPerResponseContextVideoPerSecond": { - "type": "number", - "description": "The cost per second of context video.", - "format": "double", - "nullable": true + "dimensions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ISelectionDemographicSelection": { + "required": [ + "keys", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "DemographicSelection" + ], + "type": "string" }, - "costPerResponseContextVideoMinimum": { - "type": "number", - "description": "The minimum cost per context video.", - "format": "double", - "nullable": true + "keys": { + "type": "array", + "items": { + "type": "string" + } }, - "discountRatio": { - "type": "number", - "description": "The discount ratio (0-1, e.g. 0.10 = 10% off).", - "format": "double", - "nullable": true + "maxRapids": { + "type": "integer", + "format": "int32" } - }, - "description": "The billing setting input data." + } }, - "CreateTopUpEndpoint_Input": { + "ISelectionEffortCappedSelection": { "required": [ - "amount" + "effortBudget", + "_t" ], - "type": "object", "properties": { - "amount": { - "type": "number", - "description": "The amount in dollars to add to the prepaid balance.", - "format": "double" + "_t": { + "enum": [ + "EffortCappedSelection" + ], + "type": "string" + }, + "effortBudget": { + "type": "integer", + "format": "int32" + }, + "retrievalMode": { + "$ref": "#/components/schemas/RetrievalMode" + }, + "maxIterations": { + "type": "integer", + "format": "int32", + "nullable": true } } }, - "CreateTopUpEndpoint_Output": { + "ISelectionLabelingSelection": { "required": [ - "url" + "_t" ], - "type": "object", "properties": { - "url": { - "type": "string", - "description": "The hosted Stripe checkout url to redirect the customer to." + "_t": { + "enum": [ + "LabelingSelection" + ], + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "effortBudget": { + "type": "integer", + "format": "int32" + }, + "retrievalMode": { + "$ref": "#/components/schemas/RetrievalMode" + }, + "maxIterations": { + "type": "integer", + "format": "int32", + "nullable": true } } }, - "CreateVolumeDiscountEndpoint_Input": { + "ISelectionShufflingSelection": { "required": [ - "minResponses", - "discountRatio" + "selections", + "_t" ], - "type": "object", "properties": { - "minResponses": { - "type": "integer", - "description": "The minimum number of responses to trigger this discount bracket.", - "format": "int64" + "_t": { + "enum": [ + "ShufflingSelection" + ], + "type": "string" }, - "discountRatio": { - "type": "number", - "description": "The discount ratio for this bracket (e.g., 0.10 for 10%).", - "format": "double" + "selections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ISelection" + } } } }, - "CreateVolumeDiscountEndpoint_Output": { + "ISelectionStaticSelection": { "required": [ - "id" + "rapidIds", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The ID of the created volume discount bracket." + "_t": { + "enum": [ + "StaticSelection" + ], + "type": "string" + }, + "rapidIds": { + "type": "array", + "items": { + "type": "string" + } } } }, - "ExternalServiceKind": { - "enum": [ - "ContextShortening", - "ImageGeneration" - ] - }, - "GetActiveBillingPeriodOverviewEndpoint_Output": { + "ISelectionValidationSelection": { "required": [ - "id", - "organizationId", - "startDate", - "endDate", - "status", - "totalGrossCost", - "totalDiscount", - "totalNetCost", - "totalResponseCount", - "lineItems" + "amount", + "validationSetId", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The billing period ID." - }, - "organizationId": { - "type": "string", - "description": "The organization the billing period belongs to." - }, - "startDate": { - "type": "string", - "description": "The start date of the billing period.", - "format": "date-time" - }, - "endDate": { - "type": "string", - "description": "The end date of the billing period.", - "format": "date-time" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/BillingPeriodStatus" - } + "_t": { + "enum": [ + "ValidationSelection" ], - "description": "The status of the billing period." - }, - "totalGrossCost": { - "type": "number", - "description": "The total gross cost before discounts.", - "format": "double" - }, - "totalDiscount": { - "type": "number", - "description": "The total discount amount.", - "format": "double" - }, - "totalNetCost": { - "type": "number", - "description": "The total net cost after discounts.", - "format": "double" + "type": "string" }, - "totalResponseCount": { + "amount": { "type": "integer", - "description": "The total number of billable responses.", - "format": "int64" + "format": "int32" }, - "lineItems": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/ILineItem" - } - } - ], - "description": "The line items (running cost, platform fees, refunds, volume discounts)." + "validationSetId": { + "type": "string" } } }, - "GetBillingPeriodOverviewEndpoint_Output": { + "IUserFilter": { "required": [ - "id", - "organizationId", - "startDate", - "endDate", - "status", - "totalGrossCost", - "totalDiscount", - "totalNetCost", - "totalResponseCount", - "settlementStale", - "lineItems" + "_t" ], "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The billing period ID." - }, - "organizationId": { - "type": "string", - "description": "The organization the billing period belongs to." - }, - "startDate": { - "type": "string", - "description": "The start date of the billing period.", - "format": "date-time" - }, - "endDate": { - "type": "string", - "description": "The end date of the billing period.", - "format": "date-time" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/BillingPeriodStatus" - } - ], - "description": "The status of the billing period." - }, - "totalGrossCost": { - "type": "number", - "description": "The total gross cost before discounts.", - "format": "double" - }, - "totalDiscount": { - "type": "number", - "description": "The total discount amount.", - "format": "double" - }, - "totalNetCost": { - "type": "number", - "description": "The total net cost after discounts.", - "format": "double" + "oneOf": [ + { + "$ref": "#/components/schemas/IUserFilterAgeUserFilter" }, - "totalResponseCount": { - "type": "integer", - "description": "The total number of billable responses.", - "format": "int64" + { + "$ref": "#/components/schemas/IUserFilterAndUserFilter" }, - "totalNonBillableCost": { - "type": "number", - "description": "The gross cost of the period's non-billable activity, if it was requested.", - "format": "double", - "nullable": true + { + "$ref": "#/components/schemas/IUserFilterCampaignUserFilter" }, - "totalNonBillableResponseCount": { - "type": "integer", - "description": "The total number of non-billable responses, if it was requested.", - "format": "int64", - "nullable": true + { + "$ref": "#/components/schemas/IUserFilterCountryUserFilter" }, - "netInvoiceableAmount": { - "type": "number", - "description": "What an invoice for this period would charge, as of the last settlement: usage net of\n discounts plus charges, minus the voucher coverage already booked. Null until the period has\n been settled.", - "format": "double", - "nullable": true + { + "$ref": "#/components/schemas/IUserFilterCustomUserFilter" }, - "voucherCoverage": { - "type": "number", - "description": "How much of the period's billable usage vouchers absorbed at the last settlement.", - "format": "double", - "nullable": true + { + "$ref": "#/components/schemas/IUserFilterDeviceUserFilter" }, - "settlementCurrency": { - "type": "string", - "description": "The currency the settlement amounts are denominated in.", - "nullable": true + { + "$ref": "#/components/schemas/IUserFilterGenderUserFilter" }, - "settledAt": { - "type": "string", - "description": "When the period was last settled.", - "format": "date-time", - "nullable": true + { + "$ref": "#/components/schemas/IUserFilterLanguageUserFilter" }, - "settlementStale": { - "type": "boolean", - "description": "Whether a billing input changed after the settlement amounts were computed, so they are\n awaiting a recompute." + { + "$ref": "#/components/schemas/IUserFilterNewUserFilter" }, - "closedBy": { - "type": "string", - "description": "The operator who closed the period without invoicing it. Null when the period closed on\n its own because nothing was left to invoice.", - "nullable": true + { + "$ref": "#/components/schemas/IUserFilterNotUserFilter" }, - "closeReason": { - "type": "string", - "description": "Why the period was closed without being invoiced.", - "nullable": true + { + "$ref": "#/components/schemas/IUserFilterOrUserFilter" }, - "closedAt": { - "type": "string", - "description": "When the period was closed without being invoiced.", - "format": "date-time", - "nullable": true + { + "$ref": "#/components/schemas/IUserFilterResponseCountUserFilter" }, - "lineItems": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/ILineItem" - } - } - ], - "description": "The line items (running cost, platform fees, refunds, volume discounts)." + { + "$ref": "#/components/schemas/IUserFilterUserScoreUserFilter" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AgeFilter": "#/components/schemas/IUserFilterAgeUserFilter", + "AndFilter": "#/components/schemas/IUserFilterAndUserFilter", + "CampaignFilter": "#/components/schemas/IUserFilterCampaignUserFilter", + "CountryFilter": "#/components/schemas/IUserFilterCountryUserFilter", + "CustomFilter": "#/components/schemas/IUserFilterCustomUserFilter", + "DeviceFilter": "#/components/schemas/IUserFilterDeviceUserFilter", + "GenderFilter": "#/components/schemas/IUserFilterGenderUserFilter", + "LanguageFilter": "#/components/schemas/IUserFilterLanguageUserFilter", + "NewUserFilter": "#/components/schemas/IUserFilterNewUserFilter", + "NotFilter": "#/components/schemas/IUserFilterNotUserFilter", + "OrFilter": "#/components/schemas/IUserFilterOrUserFilter", + "ResponseCountFilter": "#/components/schemas/IUserFilterResponseCountUserFilter", + "UserScoreFilter": "#/components/schemas/IUserFilterUserScoreUserFilter" } } }, - "GetBillingSettingsTimelineEndpoint_Output": { + "IUserFilterAgeUserFilter": { "required": [ - "intervals" + "ageGroups", + "_t" ], - "type": "object", "properties": { - "intervals": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBillingSettingsTimelineEndpoint_Output_Interval" - } - } + "_t": { + "enum": [ + "AgeFilter" ], - "description": "The billing settings intervals." + "type": "string" + }, + "ageGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgeUserFilter_AgeGroup" + } } } }, - "GetBillingSettingsTimelineEndpoint_Output_Interval": { + "IUserFilterAndUserFilter": { "required": [ - "costPerResponseFreeText", - "costPerResponseImage", - "costPerResponseMediaPerSecond", - "costPerResponseMediaMinimum", - "costPerResponseTextPer50Chars", - "costPerResponseContextTextPer50Chars", - "costPerResponseContextTextMinimum", - "costPerResponseContextImage", - "costPerResponseContextVideoPerSecond", - "costPerResponseContextVideoMinimum", - "discountRatio" + "filters", + "_t" ], - "type": "object", "properties": { - "from": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "to": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "costPerResponseFreeText": { - "type": "number", - "format": "double" - }, - "costPerResponseImage": { - "type": "number", - "format": "double" - }, - "costPerResponseMediaPerSecond": { - "type": "number", - "format": "double" - }, - "costPerResponseMediaMinimum": { - "type": "number", - "format": "double" - }, - "costPerResponseTextPer50Chars": { - "type": "number", - "format": "double" - }, - "costPerResponseContextTextPer50Chars": { - "type": "number", - "format": "double" + "_t": { + "enum": [ + "AndFilter" + ], + "type": "string" }, - "costPerResponseContextTextMinimum": { - "type": "number", - "format": "double" + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IUserFilter" + } + } + } + }, + "IUserFilterCampaignUserFilter": { + "required": [ + "campaignIds", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "CampaignFilter" + ], + "type": "string" }, - "costPerResponseContextImage": { - "type": "number", - "format": "double" + "campaignIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IUserFilterCountryUserFilter": { + "required": [ + "countries", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "CountryFilter" + ], + "type": "string" }, - "costPerResponseContextVideoPerSecond": { - "type": "number", - "format": "double" + "countries": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IUserFilterCustomUserFilter": { + "required": [ + "identifier", + "values", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "CustomFilter" + ], + "type": "string" }, - "costPerResponseContextVideoMinimum": { - "type": "number", - "format": "double" + "identifier": { + "type": "string" }, - "discountRatio": { - "type": "number", - "format": "double" + "values": { + "type": "array", + "items": { + "type": "string" + } } } }, - "GetBillingSummaryEndpoint_Output": { + "IUserFilterDeviceUserFilter": { "required": [ - "mode", - "currentPeriodUsage", - "minimumSpendCommitment" + "deviceTypes", + "_t" ], - "type": "object", "properties": { - "mode": { - "allOf": [ - { - "$ref": "#/components/schemas/BillingSummaryMode" - } + "_t": { + "enum": [ + "DeviceFilter" ], - "description": "How the billing summary should be presented (usage, limited, or prepaid)." - }, - "currentPeriodUsage": { - "type": "number", - "description": "The accumulated billable spend in the current billing period.", - "format": "double" - }, - "effectiveLimit": { - "type": "number", - "description": "The spending cap for the current period, or null when unlimited.", - "format": "double", - "nullable": true - }, - "availableAmount": { - "type": "number", - "description": "The remaining prepaid balance, set only for prepaid customers.", - "format": "double", - "nullable": true - }, - "minimumSpendCommitment": { - "type": "number", - "description": "Dollars the customer has committed to spend per billing period; 0 means no commitment.", - "format": "double" + "type": "string" }, - "platformFee": { - "type": "number", - "description": "The recurring fee charged once per billing period. null means no platform fee and\n no line item; 0 is an explicit $0 fee that is still itemized.", - "format": "double", - "nullable": true + "deviceTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeviceType" + } } } }, - "GetBulkCloseBillingPeriodsStatusEndpoint_Output": { + "IUserFilterGenderUserFilter": { "required": [ - "bulkCloseId", - "state", - "dryRun", - "endedBefore", - "reason", - "expectedTotal", - "processed", - "succeeded", - "failed", - "writeOffAmount", - "createdAt", - "createdById", - "createdByMail", - "periods" + "genders", + "_t" ], - "type": "object", "properties": { - "bulkCloseId": { - "type": "string", - "description": "The run this progress is about." - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/BulkBillingPeriodCloseState" - } + "_t": { + "enum": [ + "GenderFilter" ], - "description": "The state of the run, not a verdict on the periods it touched: Sweeping is queued or\n in progress, Completed means it reached the end of its selection and NOT that every\n period succeeded (read failed and each period's error for that), and\n Failed means the run itself died early with sweepError saying why." - }, - "dryRun": { - "type": "boolean", - "description": "Whether this run only reports what it would have written off." - }, - "endedBefore": { - "type": "string", - "description": "The selection's cut-off date.", - "format": "date-time" - }, - "maxNetInvoiceableAmount": { - "type": "number", - "description": "The selection's cap, or null when the run was uncapped.", - "format": "double", - "nullable": true - }, - "reason": { - "type": "string", - "description": "Why the remaining amounts will never be invoiced." - }, - "expectedTotal": { - "type": "integer", - "description": "How many periods matched the selection when the sweep started. Zero until it starts.", - "format": "int32" - }, - "processed": { - "type": "integer", - "description": "How many periods the run has reached so far.", - "format": "int32" - }, - "succeeded": { - "type": "integer", - "description": "How many periods were closed, or would be closed in a dry run.", - "format": "int32" - }, - "failed": { - "type": "integer", - "description": "How many periods were refused or failed. A non-zero count here does not stop the run, and\n does not make its state Failed.", - "format": "int32" - }, - "writeOffAmount": { - "type": "number", - "description": "The total written off so far, or the total that would be written off in a dry run.", - "format": "double" - }, - "sweepError": { - "type": "string", - "description": "Why the run itself stopped early, when it did. Set only for a run-level failure; a period\n the sweep refused leaves this null and reports itself in its own error.", - "nullable": true - }, - "createdAt": { - "type": "string", - "description": "When the run was requested.", - "format": "date-time" - }, - "createdById": { - "type": "string", - "description": "The operator accountable for the run, as recorded on every period it closes.", - "format": "uuid" - }, - "createdByMail": { - "type": "string", - "description": "The operator's mail address." - }, - "completedAt": { - "type": "string", - "description": "When the run finished, whether it completed or failed. Null while it is still sweeping.", - "format": "date-time", - "nullable": true + "type": "string" }, - "periods": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetBulkCloseBillingPeriodsStatusEndpoint_Output_Period" - } - } - ], - "description": "One verdict per period the run has reached, oldest period first." + "genders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GenderUserFilter_Gender" + } } } }, - "GetBulkCloseBillingPeriodsStatusEndpoint_Output_Period": { + "IUserFilterLanguageUserFilter": { "required": [ - "billingPeriodId", - "writeOffAmount" + "languages", + "_t" ], - "type": "object", "properties": { - "billingPeriodId": { + "_t": { + "enum": [ + "LanguageFilter" + ], "type": "string" }, - "organizationId": { - "type": "string", - "nullable": true - }, - "writeOffAmount": { - "type": "number", - "format": "double" - }, - "error": { - "type": "string", - "nullable": true + "languages": { + "type": "array", + "items": { + "type": "string" + } } } }, - "GetBulkReconciliationStatusEndpoint_Output": { + "IUserFilterNewUserFilter": { "required": [ - "bulkReconciliationId", - "dispatchState", - "expectedTotal", - "totalJobs", - "pendingJobs", - "runningJobs", - "completedJobs", - "failedJobs", - "rapidsProcessed", - "rapidsUpdated", - "rapidsAlreadyCorrect", - "rapidsFailed", - "responsesProcessed", - "correctionsCreated", - "responsesAlreadyCorrect", - "responsesFailed", - "createdAt" + "_t" ], - "type": "object", "properties": { - "bulkReconciliationId": { - "type": "string", - "description": "The bulk reconciliation identifier for the bulk operation." - }, - "correlationId": { - "type": "string", - "description": "The correlation identifier for the bulk operation.", - "nullable": true, - "deprecated": true - }, - "dispatchState": { - "allOf": [ - { - "$ref": "#/components/schemas/BulkReconciliationDispatchState" - } + "_t": { + "enum": [ + "NewUserFilter" ], - "description": "The current dispatch state (Dispatching, Completed, Failed)." - }, - "expectedTotal": { - "type": "integer", - "description": "The expected total number of billing items to dispatch.", - "format": "int32" - }, - "dispatchCompletedAt": { - "type": "string", - "description": "The timestamp when dispatching finished. Null if still dispatching.", - "format": "date-time", - "nullable": true - }, - "totalJobs": { - "type": "integer", - "description": "The total number of reconciliation jobs in this bulk operation.", - "format": "int32" - }, - "pendingJobs": { - "type": "integer", - "description": "The number of jobs in Pending state.", - "format": "int32" - }, - "runningJobs": { - "type": "integer", - "description": "The number of jobs in Running state.", - "format": "int32" - }, - "completedJobs": { - "type": "integer", - "description": "The number of jobs in Completed state.", - "format": "int32" - }, - "failedJobs": { - "type": "integer", - "description": "The number of jobs in Failed state.", - "format": "int32" - }, - "rapidsProcessed": { - "type": "integer", - "description": "The total number of rapids processed across all jobs.", - "format": "int32" - }, - "rapidsUpdated": { - "type": "integer", - "description": "The total number of rapids updated across all jobs.", - "format": "int32" - }, - "rapidsAlreadyCorrect": { - "type": "integer", - "description": "The total number of rapids already correct across all jobs.", - "format": "int32" - }, - "rapidsFailed": { - "type": "integer", - "description": "The total number of rapids that failed across all jobs.", - "format": "int32" - }, - "responsesProcessed": { - "type": "integer", - "description": "The total number of responses processed across all jobs.", - "format": "int32" - }, - "correctionsCreated": { - "type": "integer", - "description": "The total number of corrections created across all jobs.", - "format": "int32" - }, - "responsesAlreadyCorrect": { - "type": "integer", - "description": "The total number of responses already correct across all jobs.", - "format": "int32" - }, - "responsesFailed": { - "type": "integer", - "description": "The total number of responses that failed across all jobs.", - "format": "int32" - }, - "createdAt": { - "type": "string", - "description": "The timestamp when the bulk operation was created.", - "format": "date-time" - }, - "completedAt": { - "type": "string", - "description": "The timestamp when all jobs completed. Null if not fully complete.", - "format": "date-time", - "nullable": true + "type": "string" } } }, - "GetCheckoutSessionEndpoint_Output": { + "IUserFilterNotUserFilter": { "required": [ - "status" + "filter", + "_t" ], - "type": "object", "properties": { - "status": { - "type": "string", - "description": "The current status of the checkout session." + "_t": { + "enum": [ + "NotFilter" + ], + "type": "string" + }, + "filter": { + "$ref": "#/components/schemas/IUserFilter" } } }, - "GetCostTimeSeriesEndpoint_CostDataPoint": { + "IUserFilterOrUserFilter": { "required": [ - "periodStart", - "grossCost", - "discount", - "netCost", - "responseCount" + "filters", + "_t" ], - "type": "object", "properties": { - "periodStart": { - "type": "string", - "format": "date-time" - }, - "grossCost": { - "type": "number", - "format": "double" - }, - "discount": { - "type": "number", - "format": "double" - }, - "netCost": { - "type": "number", - "format": "double" - }, - "cost": { - "type": "number", - "format": "double", - "deprecated": true + "_t": { + "enum": [ + "OrFilter" + ], + "type": "string" }, - "responseCount": { - "type": "integer", - "format": "int64" + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IUserFilter" + } } } }, - "GetCostTimeSeriesEndpoint_Output": { + "IUserFilterResponseCountUserFilter": { "required": [ - "timeSeries", - "totalGrossCost", - "totalDiscount", - "totalNetCost" + "responseCount", + "dimension", + "operator", + "_t" ], - "type": "object", "properties": { - "timeSeries": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetCostTimeSeriesEndpoint_CostDataPoint" - } - } + "_t": { + "enum": [ + "ResponseCountFilter" ], - "description": "The time series data points." - }, - "totalGrossCost": { - "type": "number", - "description": "The total gross cost across all data points.", - "format": "double" + "type": "string" }, - "totalDiscount": { - "type": "number", - "description": "The total discount across all data points.", - "format": "double" + "responseCount": { + "type": "integer", + "format": "uint32" }, - "totalNetCost": { - "type": "number", - "description": "The total net cost across all data points.", - "format": "double" + "dimension": { + "type": "string" }, - "totalCost": { - "type": "number", - "description": "Deprecated. Use TotalNetCost instead.", - "format": "double", - "deprecated": true + "operator": { + "$ref": "#/components/schemas/ComparisonOperator" } - }, - "description": "The output for the cost time series endpoint." + } }, - "GetInvoiceEndpoint_Output": { + "IUserFilterUserScoreUserFilter": { "required": [ - "id", - "billingPeriodId", - "billingPeriodStart", - "billingPeriodEnd", - "status", - "amountDue", - "createdAt" + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The invoice ID." - }, - "billingPeriodId": { - "type": "string", - "description": "The billing period this invoice belongs to." - }, - "billingPeriodStart": { - "type": "string", - "description": "The start date of the billing period.", - "format": "date-time" - }, - "billingPeriodEnd": { - "type": "string", - "description": "The end date of the billing period.", - "format": "date-time" - }, - "stripeInvoiceId": { - "type": "string", - "description": "The Stripe invoice ID.", - "nullable": true - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/InvoiceStatus" - } + "_t": { + "enum": [ + "UserScoreFilter" ], - "description": "The current invoice status." + "type": "string" }, - "amountDue": { - "type": "integer", - "description": "The total amount due in cents.", - "format": "int64" + "lowerbound": { + "type": "number", + "format": "double" }, - "currency": { - "type": "string", - "description": "The invoice currency.", - "nullable": true + "upperbound": { + "type": "number", + "format": "double" }, - "createdAt": { + "dimension": { "type": "string", - "description": "When the invoice was created.", - "format": "date-time" + "nullable": true + } + } + }, + "JobDefinitionRevisionState": { + "enum": [ + "Pending", + "Completed", + "Failed" + ] + }, + "JobNavigationItem": { + "required": [ + "rapidId", + "asset", + "state" + ], + "type": "object", + "properties": { + "rapidId": { + "type": "string" }, - "finalizedAt": { - "type": "string", - "description": "When the invoice was finalized.", - "format": "date-time", - "nullable": true + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "paidAt": { - "type": "string", - "description": "When the invoice was paid.", - "format": "date-time", - "nullable": true + "state": { + "$ref": "#/components/schemas/RapidState" } } }, - "GetReconciliationStatusEndpoint_Output": { + "JobRapidResult": { "required": [ - "jobId", - "billingId", + "rapidId", + "asset", + "responses", + "totalResponseCount", "state", - "timestampMode", - "rapidsProcessed", - "rapidsUpdated", - "rapidsAlreadyCorrect", - "rapidsFailed", - "responsesProcessed", - "correctionsCreated", - "responsesAlreadyCorrect", - "responsesFailed", - "createdAt", - "createdById", - "createdByMail" + "payload" ], "type": "object", "properties": { - "jobId": { - "type": "string", - "description": "The unique identifier of the reconciliation job." + "rapidId": { + "type": "string" }, - "billingId": { - "type": "string", - "description": "The billing item identifier this job reconciles." + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "bulkReconciliationId": { - "type": "string", - "description": "The bulk reconciliation identifier if this job was created as part of a bulk operation.", - "nullable": true + "responses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/JobResponse" + } }, - "correlationId": { - "type": "string", - "description": "The correlation identifier if this job was created as part of a bulk operation.", - "nullable": true, - "deprecated": true + "totalResponseCount": { + "type": "integer", + "format": "int64" }, "state": { - "allOf": [ + "$ref": "#/components/schemas/RapidState" + }, + "payload": { + "$ref": "#/components/schemas/IRapidPayload" + }, + "context": { + "type": "string", + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/ReconciliationJobState" + "$ref": "#/components/schemas/IAsset" } ], - "description": "The current state of the reconciliation job." + "nullable": true }, - "timestampMode": { - "allOf": [ + "decisiveness": { + "type": "number", + "format": "double", + "nullable": true + }, + "aggregation": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/ReconciliationTimestampMode" + "$ref": "#/components/schemas/IResponseAggregation" } ], - "description": "The timestamp mode used for correction entries." - }, - "rapidsProcessed": { - "type": "integer", - "description": "The total number of rapids processed.", - "format": "int32" - }, - "rapidsUpdated": { - "type": "integer", - "description": "The number of rapids that were updated.", - "format": "int32" - }, - "rapidsAlreadyCorrect": { - "type": "integer", - "description": "The number of rapids that were already correct.", - "format": "int32" - }, - "rapidsFailed": { - "type": "integer", - "description": "The number of rapids that failed during reconciliation.", - "format": "int32" - }, - "responsesProcessed": { - "type": "integer", - "description": "The total number of responses processed.", - "format": "int32" + "nullable": true + } + } + }, + "JobResponse": { + "required": [ + "id", + "userId", + "country", + "language", + "age", + "gender", + "occupation", + "result", + "userScore", + "userScores", + "demographicInformation" + ], + "type": "object", + "properties": { + "id": { + "type": "string" }, - "correctionsCreated": { - "type": "integer", - "description": "The number of correction entries created.", - "format": "int32" + "userId": { + "type": "string" }, - "responsesAlreadyCorrect": { - "type": "integer", - "description": "The number of responses that were already correct.", - "format": "int32" + "country": { + "type": "string" }, - "responsesFailed": { - "type": "integer", - "description": "The number of responses that failed during reconciliation.", - "format": "int32" + "language": { + "type": "string" }, - "errorMessage": { + "age": { "type": "string", - "description": "The error message if the job failed.", "nullable": true }, - "completedAt": { + "gender": { "type": "string", - "description": "The timestamp when the job completed.", - "format": "date-time", "nullable": true }, - "createdAt": { + "occupation": { "type": "string", - "description": "The timestamp when the job was created.", - "format": "date-time" + "nullable": true }, - "createdById": { - "type": "string", - "description": "The identifier of the user who created the job.", - "format": "uuid" + "result": { + "$ref": "#/components/schemas/IRapidResult" }, - "createdByMail": { - "type": "string", - "description": "The email of the user who created the job." + "userScore": { + "type": "number", + "format": "double" + }, + "userScores": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double" + } + }, + "demographicInformation": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "GetVolumeDiscountsEndpoint_Output": { + "LabelingState": { + "enum": [ + "Created", + "Started", + "Labeling", + "Paused", + "Done", + "Failed" + ] + }, + "LineResult_Line": { "required": [ - "items" + "size", + "points" ], "type": "object", "properties": { - "items": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetVolumeDiscountsEndpoint_Output_VolumeDiscountItem" - } - } - ], - "description": "The volume discount brackets." + "size": { + "type": "number", + "format": "double" + }, + "points": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineResult_LinePoint" + } } } }, - "GetVolumeDiscountsEndpoint_Output_VolumeDiscountItem": { + "LineResult_LinePoint": { "required": [ - "id", - "minResponses", - "discountRatio" + "x", + "y" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "minResponses": { - "type": "integer", - "format": "int64" + "x": { + "type": "number", + "format": "double" }, - "discountRatio": { + "y": { "type": "number", "format": "double" } } }, - "GrantVoucherEndpoint_Input": { + "LocateCoordinate": { "required": [ - "organizationId", - "amount" + "x", + "y" ], "type": "object", "properties": { - "organizationId": { - "type": "string", - "description": "The id of the organization to grant the voucher to." - }, - "amount": { + "x": { "type": "number", - "description": "The face value of the voucher in dollars.", "format": "double" }, - "validity": { - "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", - "type": "string", - "description": "How long the voucher stays valid, counted from now. Serialized as a duration string in\n the format [days.]hh:mm:ss (the days part is optional): \"30.00:00:00\" = 30\n days, \"7.00:00:00\" = 7 days, \"12:00:00\" = 12 hours. Must be positive.\n Provide this or expiresAt, not both.", - "nullable": true - }, - "expiresAt": { - "type": "string", - "description": "An explicit expiry instant as an ISO-8601 timestamp (e.g. \"2026-12-31T23:59:59Z\").\n Use this instead of validity when you know the exact date the\n voucher should expire. Provide this or validity, not both.", - "format": "date-time", - "nullable": true + "y": { + "type": "number", + "format": "double" } } }, - "GrantVoucherEndpoint_Output": { + "NamedEntityResult_NamedClassification": { "required": [ - "voucherId" + "start", + "end", + "classification" ], "type": "object", "properties": { - "voucherId": { - "type": "string", - "description": "The id of the granted voucher." + "start": { + "type": "integer", + "format": "int32" + }, + "end": { + "type": "integer", + "format": "int32" + }, + "classification": { + "type": "string" } } }, - "IBillingGroup": { + "OrderState": { + "enum": [ + "Created", + "Preview", + "Submitted", + "ManualReview", + "Queued", + "Processing", + "Paused", + "Completed", + "Cancelled", + "Failed", + "StaleResults" + ] + }, + "PolygonResult_Coordinate": { "required": [ - "_t" + "x", + "y" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IBillingGroupAudienceDistillationBillingGroup" - }, - { - "$ref": "#/components/schemas/IBillingGroupAudienceJobBillingGroup" - }, - { - "$ref": "#/components/schemas/IBillingGroupBenchmarkBillingGroup" - }, - { - "$ref": "#/components/schemas/IBillingGroupOrderBillingGroup" - }, - { - "$ref": "#/components/schemas/IBillingGroupRankingFlowBillingGroup" + "properties": { + "x": { + "type": "number", + "format": "double", + "nullable": true }, - { - "$ref": "#/components/schemas/IBillingGroupValidationSetBillingGroup" + "y": { + "type": "number", + "format": "double", + "nullable": true } + } + }, + "PolygonResult_Shape": { + "required": [ + "edges" ], - "description": "A billable group of responses on a billing period, identified by a discriminator.\n Implementations describe the source of the charges (order, benchmark, audience job, etc.).", - "discriminator": { - "propertyName": "_t", - "mapping": { - "AudienceDistillationBillingGroup": "#/components/schemas/IBillingGroupAudienceDistillationBillingGroup", - "AudienceJobBillingGroup": "#/components/schemas/IBillingGroupAudienceJobBillingGroup", - "BenchmarkBillingGroup": "#/components/schemas/IBillingGroupBenchmarkBillingGroup", - "OrderBillingGroup": "#/components/schemas/IBillingGroupOrderBillingGroup", - "RankingFlowBillingGroup": "#/components/schemas/IBillingGroupRankingFlowBillingGroup", - "ValidationSetBillingGroup": "#/components/schemas/IBillingGroupValidationSetBillingGroup" + "type": "object", + "properties": { + "edges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PolygonResult_Coordinate" + } } } }, - "IBillingGroupAudienceDistillationBillingGroup": { + "PreviewOrderEndpoint_Input": { + "type": "object", + "properties": { + "ignoreFailedDatapoints": { + "type": "boolean", + "description": "Whether the order should proceed even if certain datapoints failed.", + "nullable": true + } + } + }, + "QueryAggregatedJobsEndpoint_Output": { "required": [ - "id", - "name", - "grossCost", - "discount", - "netCost", - "responseCount", - "audienceId", - "_t" + "amount", + "last7Days", + "lastJobDate", + "lastJobName", + "lastJobId", + "ownerMail", + "organizationId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "AudienceDistillationBillingGroup" - ], - "type": "string" + "amount": { + "type": "integer", + "description": "The total number of jobs for this customer.", + "format": "int32" }, - "id": { - "type": "string", - "description": "The unique identifier of the billing group." + "last7Days": { + "type": "integer", + "description": "The number of jobs created in the last 7 days.", + "format": "int32" }, - "name": { + "lastJobDate": { "type": "string", - "description": "A human-readable name for the billing group." - }, - "grossCost": { - "type": "number", - "description": "The gross cost of the responses in this group, before any discount.", - "format": "double" - }, - "discount": { - "type": "number", - "description": "The absolute discount applied to the gross cost.", - "format": "double" - }, - "netCost": { - "type": "number", - "description": "The net cost of the responses in this group after discount.", - "format": "double" + "description": "The date of the most recent job.", + "format": "date-time" }, - "responseCount": { - "type": "integer", - "description": "The number of responses attributed to this billing group.", - "format": "int64" + "lastJobName": { + "type": "string", + "description": "The name of the most recent job." }, - "audienceId": { + "lastJobId": { "type": "string", - "description": "The identifier of the audience the distillation run was executed for." + "description": "The ID of the most recent job." }, - "nonBillableCost": { - "type": "number", - "description": "The gross cost of this group's non-billable activity, if it was requested.", - "format": "double", - "nullable": true + "ownerMail": { + "type": "string", + "description": "The customer's email address." }, - "nonBillableResponseCount": { - "type": "integer", - "description": "The number of non-billable responses in this group, if it was requested.", - "format": "int64", - "nullable": true + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." } - }, - "description": "A billing group for responses produced by an audience distillation run." + } }, - "IBillingGroupAudienceJobBillingGroup": { + "QueryAggregatedJobsEndpoint_PagedResultOfOutput": { "required": [ - "id", - "name", - "grossCost", - "discount", - "netCost", - "responseCount", - "jobId", - "audienceId", - "_t" + "total", + "page", + "pageSize", + "items" ], - "properties": { - "_t": { - "enum": [ - "AudienceJobBillingGroup" - ], - "type": "string" - }, - "id": { - "type": "string", - "description": "The unique identifier of the billing group." - }, - "name": { - "type": "string", - "description": "A human-readable name for the billing group." - }, - "grossCost": { - "type": "number", - "description": "The gross cost of the responses in this group, before any discount.", - "format": "double" - }, - "discount": { - "type": "number", - "description": "The absolute discount applied to the gross cost.", - "format": "double" - }, - "netCost": { - "type": "number", - "description": "The net cost of the responses in this group after discount.", - "format": "double" - }, - "responseCount": { + "type": "object", + "properties": { + "total": { "type": "integer", - "description": "The number of responses attributed to this billing group.", "format": "int64" }, - "jobId": { - "type": "string", - "description": "The identifier of the audience job that produced the responses." + "page": { + "type": "integer", + "format": "int32" }, - "audienceId": { - "type": "string", - "description": "The identifier of the audience the job belongs to." + "pageSize": { + "type": "integer", + "format": "int32" }, - "nonBillableCost": { - "type": "number", - "description": "The gross cost of this group's non-billable activity, if it was requested.", - "format": "double", - "nullable": true + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryAggregatedJobsEndpoint_Output" + } }, - "nonBillableResponseCount": { + "totalPages": { "type": "integer", - "description": "The number of non-billable responses in this group, if it was requested.", - "format": "int64", - "nullable": true + "format": "int32" } - }, - "description": "A billing group for responses produced by an audience job." + } }, - "IBillingGroupBenchmarkBillingGroup": { + "QueryAggregatedOrdersEndpoint_Output": { "required": [ - "id", - "name", - "grossCost", - "discount", - "netCost", - "responseCount", - "benchmarkId", - "_t" + "amount", + "last7Days", + "lastOrderDate", + "lastOrderName", + "lastOrderId", + "customerMail" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "BenchmarkBillingGroup" - ], - "type": "string" + "amount": { + "type": "integer", + "description": "The total number of orders for this customer.", + "format": "int32" }, - "id": { - "type": "string", - "description": "The unique identifier of the billing group." + "last7Days": { + "type": "integer", + "description": "The number of orders placed in the last 7 days.", + "format": "int32" }, - "name": { + "lastOrderDate": { "type": "string", - "description": "A human-readable name for the billing group." - }, - "grossCost": { - "type": "number", - "description": "The gross cost of the responses in this group, before any discount.", - "format": "double" + "description": "The date of the most recent order.", + "format": "date-time" }, - "discount": { - "type": "number", - "description": "The absolute discount applied to the gross cost.", - "format": "double" + "lastOrderName": { + "type": "string", + "description": "The name of the most recent order." }, - "netCost": { - "type": "number", - "description": "The net cost of the responses in this group after discount.", - "format": "double" + "lastOrderId": { + "type": "string", + "description": "The ID of the most recent order." }, - "responseCount": { + "customerMail": { + "type": "string", + "description": "The customer's email address." + } + } + }, + "QueryAggregatedOrdersEndpoint_PagedResultOfOutput": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { "type": "integer", - "description": "The number of responses attributed to this billing group.", "format": "int64" }, - "benchmarkId": { - "type": "string", - "description": "The identifier of the benchmark that produced the responses." + "page": { + "type": "integer", + "format": "int32" }, - "nonBillableCost": { - "type": "number", - "description": "The gross cost of this group's non-billable activity, if it was requested.", - "format": "double", - "nullable": true + "pageSize": { + "type": "integer", + "format": "int32" }, - "nonBillableResponseCount": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryAggregatedOrdersEndpoint_Output" + } + }, + "totalPages": { "type": "integer", - "description": "The number of non-billable responses in this group, if it was requested.", - "format": "int64", - "nullable": true + "format": "int32" } - }, - "description": "A billing group for responses produced by a benchmark." + } }, - "IBillingGroupOrderBillingGroup": { + "QueryJobDefinitionsEndpoint_Output": { "required": [ - "id", + "definitionId", "name", - "grossCost", - "discount", - "netCost", - "responseCount", - "orderId", - "_t" + "definitionType", + "createdAt", + "revisionCount", + "ownerId", + "ownerMail", + "organizationId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "OrderBillingGroup" - ], - "type": "string" - }, - "id": { + "definitionId": { "type": "string", - "description": "The unique identifier of the billing group." + "description": "The id of the job definition." }, "name": { "type": "string", - "description": "A human-readable name for the billing group." - }, - "grossCost": { - "type": "number", - "description": "The gross cost of the responses in this group, before any discount.", - "format": "double" + "description": "The name of the job definition." }, - "discount": { - "type": "number", - "description": "The absolute discount applied to the gross cost.", - "format": "double" + "definitionType": { + "allOf": [ + { + "$ref": "#/components/schemas/DefinitionType" + } + ], + "description": "The type of the job definition." }, - "netCost": { - "type": "number", - "description": "The net cost of the responses in this group after discount.", - "format": "double" + "createdAt": { + "type": "string", + "description": "The creation timestamp of the job definition.", + "format": "date-time" }, - "responseCount": { + "revisionCount": { "type": "integer", - "description": "The number of responses attributed to this billing group.", - "format": "int64" + "description": "The number of revisions for this job definition.", + "format": "int32" }, - "orderId": { + "ownerId": { "type": "string", - "description": "The identifier of the order that produced the responses." + "description": "The id of the owner of the job definition.", + "format": "uuid" }, - "nonBillableCost": { - "type": "number", - "description": "The gross cost of this group's non-billable activity, if it was requested.", - "format": "double", - "nullable": true + "ownerMail": { + "type": "string", + "description": "The email of the owner of the job definition." }, - "nonBillableResponseCount": { - "type": "integer", - "description": "The number of non-billable responses in this group, if it was requested.", - "format": "int64", - "nullable": true + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." } - }, - "description": "A billing group for responses produced by an order." + } }, - "IBillingGroupRankingFlowBillingGroup": { + "QueryJobDefinitionsEndpoint_PagedResultOfOutput": { "required": [ - "id", - "name", - "grossCost", - "discount", - "netCost", - "responseCount", - "flowId", - "_t" + "total", + "page", + "pageSize", + "items" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "RankingFlowBillingGroup" - ], - "type": "string" - }, - "id": { - "type": "string", - "description": "The unique identifier of the billing group." - }, - "name": { - "type": "string", - "description": "A human-readable name for the billing group." - }, - "grossCost": { - "type": "number", - "description": "The gross cost of the responses in this group, before any discount.", - "format": "double" - }, - "discount": { - "type": "number", - "description": "The absolute discount applied to the gross cost.", - "format": "double" - }, - "netCost": { - "type": "number", - "description": "The net cost of the responses in this group after discount.", - "format": "double" - }, - "responseCount": { + "total": { "type": "integer", - "description": "The number of responses attributed to this billing group.", "format": "int64" }, - "flowId": { - "type": "string", - "description": "The identifier of the ranking flow that produced the responses." + "page": { + "type": "integer", + "format": "int32" }, - "nonBillableCost": { - "type": "number", - "description": "The gross cost of this group's non-billable activity, if it was requested.", - "format": "double", - "nullable": true + "pageSize": { + "type": "integer", + "format": "int32" }, - "nonBillableResponseCount": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryJobDefinitionsEndpoint_Output" + } + }, + "totalPages": { "type": "integer", - "description": "The number of non-billable responses in this group, if it was requested.", - "format": "int64", - "nullable": true + "format": "int32" } - }, - "description": "A billing group for responses produced by a ranking flow." + } }, - "IBillingGroupValidationSetBillingGroup": { + "QueryJobRevisionsEndpoint_Output": { "required": [ - "id", - "name", - "grossCost", - "discount", - "netCost", - "responseCount", - "validationSetId", - "_t" + "definitionId", + "revisionNumber", + "createdAt", + "state" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ValidationSetBillingGroup" - ], - "type": "string" - }, - "id": { - "type": "string", - "description": "The unique identifier of the billing group." - }, - "name": { + "definitionId": { "type": "string", - "description": "A human-readable name for the billing group." - }, - "grossCost": { - "type": "number", - "description": "The gross cost of the responses in this group, before any discount.", - "format": "double" - }, - "discount": { - "type": "number", - "description": "The absolute discount applied to the gross cost.", - "format": "double" - }, - "netCost": { - "type": "number", - "description": "The net cost of the responses in this group after discount.", - "format": "double" + "description": "The id of the job definition this revision belongs to." }, - "responseCount": { + "revisionNumber": { "type": "integer", - "description": "The number of responses attributed to this billing group.", - "format": "int64" + "description": "The revision number.", + "format": "int32" }, - "validationSetId": { + "createdAt": { "type": "string", - "description": "The identifier of the validation set that produced the responses." - }, - "nonBillableCost": { - "type": "number", - "description": "The gross cost of this group's non-billable activity, if it was requested.", - "format": "double", - "nullable": true + "description": "The timestamp when this revision was created.", + "format": "date-time" }, - "nonBillableResponseCount": { - "type": "integer", - "description": "The number of non-billable responses in this group, if it was requested.", - "format": "int64", - "nullable": true + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/JobDefinitionRevisionState" + } + ], + "description": "The current state of the revision." } - }, - "description": "A billing group for responses produced by a validation set." + } }, - "ILineItem": { + "QueryJobRevisionsEndpoint_PagedResultOfOutput": { "required": [ - "_t" + "total", + "page", + "pageSize", + "items" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/ILineItemMinimumSpendCommitment" - }, - { - "$ref": "#/components/schemas/ILineItemOtherCharge" + "properties": { + "total": { + "type": "integer", + "format": "int64" }, - { - "$ref": "#/components/schemas/ILineItemPlatformFee" + "page": { + "type": "integer", + "format": "int32" }, - { - "$ref": "#/components/schemas/ILineItemRefund" + "pageSize": { + "type": "integer", + "format": "int32" }, - { - "$ref": "#/components/schemas/ILineItemRunningCost" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryJobRevisionsEndpoint_Output" + } }, - { - "$ref": "#/components/schemas/ILineItemVolumeDiscount" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "MinimumSpendCommitment": "#/components/schemas/ILineItemMinimumSpendCommitment", - "Other": "#/components/schemas/ILineItemOtherCharge", - "PlatformFee": "#/components/schemas/ILineItemPlatformFee", - "Refund": "#/components/schemas/ILineItemRefund", - "RunningCost": "#/components/schemas/ILineItemRunningCost", - "VolumeDiscount": "#/components/schemas/ILineItemVolumeDiscount" + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "ILineItemMinimumSpendCommitment": { + "QueryJobsEndpoint_Output": { "required": [ + "jobId", "name", - "amount", - "_t" + "jobDefinitionId", + "audienceId", + "revisionNumber", + "pipelineId", + "state", + "ownerMail", + "organizationId", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "MinimumSpendCommitment" - ], - "type": "string" - }, - "id": { + "jobId": { "type": "string", - "nullable": true + "description": "The id of the job." }, "name": { - "type": "string" + "type": "string", + "description": "The name of the job." }, - "amount": { - "type": "number", - "format": "double" + "definitionId": { + "type": "string", + "description": "The id of the job definition.", + "nullable": true, + "deprecated": true }, - "comment": { + "jobDefinitionId": { "type": "string", - "nullable": true - } - } - }, - "ILineItemOtherCharge": { - "required": [ - "id", - "name", - "amount", - "quantity", - "unitPrice", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "Other" - ], - "type": "string" + "description": "The id of the job definition." }, - "id": { - "type": "string" + "audienceId": { + "type": "string", + "description": "The id of the audience associated with the job." }, - "name": { - "type": "string" + "revisionNumber": { + "type": "integer", + "description": "The revision number of the job.", + "format": "int32" + }, + "pipelineId": { + "type": "string", + "description": "The id of the pipeline executing the job." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/AudienceJobState" + } + ], + "description": "The current state of the job.", + "deprecated": true + }, + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/AudienceJobState" + } + ], + "description": "The current state of the job." }, - "amount": { - "type": "number", - "format": "double" + "ownerMail": { + "type": "string", + "description": "The email of the job's owner." }, - "comment": { + "organizationId": { "type": "string", - "nullable": true + "description": "The id of the organization that owns the entity." }, - "quantity": { - "type": "integer", - "format": "int32" + "createdAt": { + "type": "string", + "description": "The timestamp when the job was created.", + "format": "date-time" }, - "unitPrice": { + "progress": { "type": "number", - "format": "double" + "description": "Labeling completion as a ratio in the range 0–1, or null when no progress has\n been reported yet (completion sets it to 1). Sortable via ?sort=progress.", + "format": "double", + "nullable": true } } }, - "ILineItemPlatformFee": { + "QueryJobsEndpoint_PagedResultOfOutput": { "required": [ - "id", - "name", - "amount", - "_t" + "total", + "page", + "pageSize", + "items" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "PlatformFee" - ], - "type": "string" + "total": { + "type": "integer", + "format": "int64" }, - "id": { - "type": "string" + "page": { + "type": "integer", + "format": "int32" }, - "name": { - "type": "string" + "pageSize": { + "type": "integer", + "format": "int32" }, - "amount": { - "type": "number", - "format": "double" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryJobsEndpoint_Output" + } }, - "comment": { - "type": "string", - "nullable": true + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "ILineItemRefund": { + "QueryOrdersEndpoint_Output": { "required": [ "id", - "name", - "amount", - "quantity", - "unitPrice", - "_t" + "pipelineId", + "orderDate", + "customerMail", + "state", + "orderName", + "isPublic" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "Refund" - ], - "type": "string" - }, "id": { - "type": "string" - }, - "name": { - "type": "string" + "type": "string", + "description": "The unique identifier of the order." }, - "amount": { - "type": "number", - "format": "double" + "pipelineId": { + "type": "string", + "description": "The ID of the pipeline associated with the order." }, - "comment": { + "orderDate": { "type": "string", + "description": "The date the order was placed.", + "format": "date-time", "nullable": true }, - "quantity": { - "type": "integer", - "format": "int32" + "customerMail": { + "type": "string", + "description": "The email of the customer who placed the order." }, - "unitPrice": { - "type": "number", - "format": "double" - } - } - }, - "ILineItemRunningCost": { - "required": [ - "amount", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "RunningCost" + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/OrderState" + } ], - "type": "string" + "description": "The current state of the order." }, - "amount": { - "type": "number", - "format": "double" - } - } - }, - "ILineItemVolumeDiscount": { - "required": [ - "amount", - "effectiveDiscountRatio", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "VolumeDiscount" - ], - "type": "string" + "orderName": { + "type": "string", + "description": "The name of the order." }, - "amount": { - "type": "number", - "format": "double" + "isPublic": { + "type": "boolean", + "description": "Whether the order is publicly visible." }, - "effectiveDiscountRatio": { - "type": "number", - "format": "double" + "failureMessage": { + "type": "string", + "description": "The failure message if the order failed.", + "nullable": true } } }, - "InvoiceStatus": { - "enum": [ - "Generating", - "Draft", - "Open", - "Paid", - "Void", - "Uncollectible", - "Failed" - ] - }, - "ManualChargeReason": { - "enum": [ - "PlatformFee", - "Refund", - "Other", - "MinimumSpendCommitment" - ] - }, - "PagedResultOfIBillingGroup": { + "QueryOrdersEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -64483,7 +60523,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/IBillingGroup" + "$ref": "#/components/schemas/QueryOrdersEndpoint_Output" } }, "totalPages": { @@ -64492,79 +60532,61 @@ } } }, - "QueryBillingPeriodsEndpoint_Output": { + "QueryPublicJobDefinitionsEndpoint_Output": { "required": [ - "id", - "organizationId", - "startDate", - "endDate", - "status", - "settlementStale", - "createdAt" + "definitionId", + "name", + "definitionType", + "createdAt", + "revisionCount", + "ownerId", + "ownerMail", + "organizationId" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The billing period ID." - }, - "organizationId": { - "type": "string", - "description": "The organization the billing period belongs to." - }, - "startDate": { + "definitionId": { "type": "string", - "description": "The start date of the billing period.", - "format": "date-time" + "description": "The id of the job definition." }, - "endDate": { + "name": { "type": "string", - "description": "The end date of the billing period.", - "format": "date-time" + "description": "The name of the job definition." }, - "status": { + "definitionType": { "allOf": [ { - "$ref": "#/components/schemas/BillingPeriodStatus" + "$ref": "#/components/schemas/DefinitionType" } ], - "description": "The status of the billing period." + "description": "The type of the job definition." }, - "netInvoiceableAmount": { - "type": "number", - "description": "What an invoice for this period would charge, as of the last settlement. Null until the\n period has been settled.", - "format": "double", - "nullable": true + "createdAt": { + "type": "string", + "description": "The creation timestamp of the job definition.", + "format": "date-time" }, - "voucherCoverage": { - "type": "number", - "description": "How much of the period's billable usage vouchers absorbed at the last settlement.", - "format": "double", - "nullable": true + "revisionCount": { + "type": "integer", + "description": "The number of revisions for this job definition.", + "format": "int32" }, - "settlementCurrency": { + "ownerId": { "type": "string", - "description": "The currency the settlement amounts are denominated in.", - "nullable": true + "description": "The id of the owner of the job definition.", + "format": "uuid" }, - "settledAt": { + "ownerMail": { "type": "string", - "description": "When the period was last settled.", - "format": "date-time", - "nullable": true - }, - "settlementStale": { - "type": "boolean", - "description": "Whether a billing input changed after the settlement amounts were computed." + "description": "The email of the owner of the job definition." }, - "createdAt": { + "organizationId": { "type": "string", - "description": "The date the billing period was created.", - "format": "date-time" + "description": "The id of the organization that owns the entity." } } }, - "QueryBillingPeriodsEndpoint_PagedResultOfOutput": { + "QueryPublicJobDefinitionsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -64588,7 +60610,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryBillingPeriodsEndpoint_Output" + "$ref": "#/components/schemas/QueryPublicJobDefinitionsEndpoint_Output" } }, "totalPages": { @@ -64597,4762 +60619,4877 @@ } } }, - "QueryCostsByCustomerEndpoint_Output": { + "RankingDatapoint": { "required": [ - "customerId", - "customerMail", - "grossCost", - "discount", - "netCost", - "responseCount" + "datapointId", + "asset", + "elo" ], "type": "object", "properties": { - "customerId": { - "type": "string", - "description": "The customer identifier.", - "format": "uuid" + "datapointId": { + "type": "string" }, - "customerMail": { - "type": "string", - "description": "The customer email." + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "grossCost": { - "type": "number", - "description": "The gross cost for this customer (before discount).", - "format": "double" + "elo": { + "type": "integer", + "format": "int32" + } + } + }, + "RapidState": { + "enum": [ + "Labeling", + "Paused", + "Incomplete", + "Flagged", + "Done", + "None", + "Rejected" + ] + }, + "ResponseTally": { + "required": [ + "count", + "userScoreSum" + ], + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int64" }, - "discount": { + "userScoreSum": { "type": "number", - "description": "The discount for this customer.", "format": "double" + } + } + }, + "RestartRapidsEndpoint_Input": { + "required": [ + "rapidIds" + ], + "type": "object", + "properties": { + "rapidIds": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The ids of the rapids to restart." + } + }, + "description": "The input for the restart rapids endpoint." + }, + "ReviewReason": { + "enum": [ + "ContentFlagged", + "UnsupportedContentType", + "CheckErrored", + "ClassificationTimedOut", + null + ] + }, + "SortDirection": { + "enum": [ + "Asc", + "Desc" + ] + }, + "StickyState": { + "enum": [ + "None", + "Temporary", + "Permanent", + "Passive", + null + ] + }, + "SubmitFeedbackEndpoint_Input": { + "required": [ + "feedback" + ], + "type": "object", + "properties": { + "feedback": { + "type": "string", + "description": "The feedback text." }, - "netCost": { - "type": "number", - "description": "The net cost for this customer (after discount).", - "format": "double" + "email": { + "type": "string", + "description": "The email of the user submitting the feedback.", + "nullable": true }, - "cost": { - "type": "number", - "description": "Deprecated. Use NetCost instead.", - "format": "double", - "deprecated": true + "token": { + "type": "string", + "description": "The recaptcha token, required when the caller is not authenticated.", + "nullable": true + } + } + }, + "SubmitOrderEndpoint_Input": { + "type": "object", + "properties": { + "ignoreFailedDatapoints": { + "type": "boolean", + "description": "Whether the order should proceed even if certain datapoints failed.", + "nullable": true + } + } + }, + "TranscriptionPayload_TranscriptionWord": { + "required": [ + "word", + "wordIndex" + ], + "type": "object", + "properties": { + "word": { + "type": "string" }, - "responseCount": { + "wordIndex": { "type": "integer", - "description": "The total number of responses for this customer.", - "format": "int64" + "format": "int32" + } + } + }, + "TranscriptionResult_TranscriptionWord": { + "required": [ + "word", + "wordIndex" + ], + "type": "object", + "properties": { + "word": { + "type": "string" + }, + "wordIndex": { + "type": "integer", + "format": "int32" + } + } + }, + "UnlockOrderEndpoint_Output": { + "required": [ + "datasetIds" + ], + "type": "object", + "properties": { + "datasetIds": { + "allOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + ], + "description": "The dataset IDs created by unlocking the order." + } + } + }, + "UpdateJobDefinitionEndpoint_Input": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The new name for the job definition." } }, - "description": "Billing cost data aggregated per customer." + "description": "The input for the update job definition endpoint." + }, + "UpdateJobEndpoint_Input": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The new name for the job." + } + }, + "description": "The input for the update job endpoint." + }, + "UpdateOrderEndpoint_Input": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The new name of the order, if specified." + }, + "precedingOrderId": { + "type": "string", + "description": "The ID of the order that must complete before this order starts processing.\n Set to null to clear an existing preceding order.", + "nullable": true + } + } + }, + "BillingPeriodStatus": { + "enum": [ + "Open", + "Invoiced", + "Void", + "Reconciling", + "PendingReview", + "Closed" + ] + }, + "BillingSummaryMode": { + "enum": [ + "Usage", + "Limited", + "Prepaid" + ] }, - "QueryCostsByCustomerEndpoint_PagedResultOfOutput": { + "BulkBillingPeriodCloseState": { + "enum": [ + "Sweeping", + "Completed", + "Failed" + ] + }, + "BulkCloseBillingPeriodsEndpoint_Input": { "required": [ - "total", - "page", - "pageSize", - "items" + "endedBefore", + "reason" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" + "endedBefore": { + "type": "string", + "description": "Only periods that ended before this date are closed.", + "format": "date-time" }, - "pageSize": { - "type": "integer", - "format": "int32" + "maxNetInvoiceableAmount": { + "type": "number", + "description": "When set, only periods with at most this much left to invoice are closed, and a period whose\n amount has grown past it since it was last settled is refused.", + "format": "double", + "nullable": true }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryCostsByCustomerEndpoint_Output" - } + "reason": { + "type": "string", + "description": "Why the remaining amounts will never be invoiced." }, - "totalPages": { - "type": "integer", - "format": "int32" + "dryRun": { + "type": "boolean", + "description": "Report what the sweep would write off without closing anything or minting any vouchers." } } }, - "QueryCostsByOrganizationEndpoint_Output": { + "BulkCloseBillingPeriodsEndpoint_Output": { "required": [ - "organizationOwnerId", - "organizationName", - "grossCost", - "discount", - "netCost", - "responseCount" + "bulkCloseId", + "dryRun" ], "type": "object", "properties": { - "organizationOwnerId": { - "type": "string", - "description": "The organization owner identifier.", - "format": "uuid" - }, - "organizationName": { + "bulkCloseId": { "type": "string", - "description": "The organization name." - }, - "grossCost": { - "type": "number", - "description": "The gross cost for this organization (before discount).", - "format": "double" - }, - "discount": { - "type": "number", - "description": "The discount for this organization.", - "format": "double" - }, - "netCost": { - "type": "number", - "description": "The net cost for this organization (after discount).", - "format": "double" - }, - "cost": { - "type": "number", - "description": "Deprecated. Use NetCost instead.", - "format": "double", - "deprecated": true + "description": "The run to poll for the sweep's progress." }, - "responseCount": { - "type": "integer", - "description": "The total number of responses for this organization.", - "format": "int64" + "dryRun": { + "type": "boolean", + "description": "Whether this run only reports what it would have written off." } - }, - "description": "Billing cost data aggregated per organization." + } }, - "QueryCostsByOrganizationEndpoint_PagedResultOfOutput": { + "BulkReconciliationDispatchState": { + "enum": [ + "Dispatching", + "Completed", + "Failed" + ] + }, + "CloseBillingPeriodEndpoint_Input": { "required": [ - "total", - "page", - "pageSize", - "items" + "reason" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryCostsByOrganizationEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" + "reason": { + "type": "string", + "description": "Why the remaining amount will never be invoiced." } } }, - "QueryInvoicesEndpoint_Output": { + "CloseBillingPeriodEndpoint_Output": { "required": [ - "id", "billingPeriodId", - "billingPeriodStart", - "billingPeriodEnd", - "status", - "amountDue", - "organizationId", - "createdAt" + "writtenOffAmount" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The invoice ID." - }, "billingPeriodId": { "type": "string", - "description": "The billing period this invoice belongs to." + "description": "The closed billing period." }, - "billingPeriodStart": { + "writtenOffAmount": { + "type": "number", + "description": "The amount that was written off.", + "format": "double" + }, + "writeOffVoucherId": { "type": "string", - "description": "The start date of the billing period.", - "format": "date-time" + "description": "The voucher that absorbed the written-off amount, or null when there was nothing left.", + "nullable": true + } + } + }, + "CreateBillingItemBillingSettingEndpoint_Input": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "description": "The priority of the setting. Defaults to the configured billing item default if not specified.", + "format": "int32", + "nullable": true }, - "billingPeriodEnd": { + "validFrom": { "type": "string", - "description": "The end date of the billing period.", - "format": "date-time" + "description": "The start of the validity window.", + "format": "date-time", + "nullable": true }, - "stripeInvoiceId": { + "validTo": { "type": "string", - "description": "The Stripe invoice ID.", + "description": "The end of the validity window.", + "format": "date-time", "nullable": true }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/InvoiceStatus" - } - ], - "description": "The current invoice status." + "costPerResponseFreeText": { + "type": "number", + "description": "The cost per free text response.", + "format": "double", + "nullable": true }, - "amountDue": { - "type": "integer", - "description": "The total amount due in cents.", - "format": "int64" + "costPerResponseImage": { + "type": "number", + "description": "The cost per image response.", + "format": "double", + "nullable": true }, - "currency": { - "type": "string", - "description": "The invoice currency.", + "costPerResponseMediaPerSecond": { + "type": "number", + "description": "The cost per second of media response.", + "format": "double", "nullable": true }, - "organizationId": { - "type": "string", - "description": "The organization the invoice belongs to." + "costPerResponseMediaMinimum": { + "type": "number", + "description": "The minimum cost per media response.", + "format": "double", + "nullable": true }, - "createdAt": { - "type": "string", - "description": "When the invoice was created.", - "format": "date-time" + "costPerResponseTextPer50Chars": { + "type": "number", + "description": "The cost per 50 characters of text response.", + "format": "double", + "nullable": true }, - "finalizedAt": { - "type": "string", - "description": "When the invoice was finalized.", - "format": "date-time", + "costPerResponseContextTextPer50Chars": { + "type": "number", + "description": "The cost per 50 characters of context text.", + "format": "double", "nullable": true }, - "paidAt": { - "type": "string", - "description": "When the invoice was paid.", - "format": "date-time", + "costPerResponseContextTextMinimum": { + "type": "number", + "description": "The minimum cost per context text.", + "format": "double", "nullable": true }, - "voidedAt": { - "type": "string", - "description": "When the invoice was voided.", - "format": "date-time", + "costPerResponseContextImage": { + "type": "number", + "description": "The cost per context image.", + "format": "double", + "nullable": true + }, + "costPerResponseContextVideoPerSecond": { + "type": "number", + "description": "The cost per second of context video.", + "format": "double", + "nullable": true + }, + "costPerResponseContextVideoMinimum": { + "type": "number", + "description": "The minimum cost per context video.", + "format": "double", + "nullable": true + }, + "discountRatio": { + "type": "number", + "description": "The discount ratio (0-1, e.g. 0.10 = 10% off).", + "format": "double", "nullable": true } - } + }, + "description": "The billing setting input data." }, - "QueryInvoicesEndpoint_PagedResultOfOutput": { + "CreateCheckoutEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "items" + "sessionId" ], "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryInvoicesEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" + "sessionId": { + "type": "string", + "description": "The id of the created checkout session." } } }, - "QueryVouchersEndpoint_Output": { + "CreateExternalServicePriceEndpoint_Input": { "required": [ - "id", - "amount", - "used", - "remaining", - "issuedAt", - "expiresAt", - "status", - "source" + "serviceKind", + "pricingKey", + "unitPrice" ], "type": "object", "properties": { - "id": { + "serviceKind": { + "allOf": [ + { + "$ref": "#/components/schemas/ExternalServiceKind" + } + ], + "description": "The service this price applies to." + }, + "pricingKey": { "type": "string", - "description": "The voucher id." + "description": "Hierarchical variant key (e.g. reve, replicate/flux-1.1-pro)." }, - "amount": { - "type": "number", - "description": "The face value of the voucher in dollars.", - "format": "double" + "customerId": { + "type": "string", + "description": "Null for the global default; set to scope the price to one customer.", + "format": "uuid", + "nullable": true }, - "used": { + "unitPrice": { "type": "number", - "description": "The amount already consumed across closed billing periods.", + "description": "Price per unit (per image / per shortening).", "format": "double" }, - "remaining": { - "type": "number", - "description": "The remaining free usage the voucher can still grant.", - "format": "double" + "priority": { + "type": "integer", + "description": "Priority; defaults to the configured global/customer default if unset.", + "format": "int32", + "nullable": true }, - "issuedAt": { + "validFrom": { "type": "string", - "description": "When the voucher was issued.", - "format": "date-time" + "description": "The start of the validity window.", + "format": "date-time", + "nullable": true }, - "expiresAt": { + "validTo": { "type": "string", - "description": "When the voucher expires.", - "format": "date-time" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/VoucherStatus" - } - ], - "description": "The voucher's lifecycle status." - }, - "source": { - "allOf": [ - { - "$ref": "#/components/schemas/VoucherSource" - } - ], - "description": "Where the voucher came from." + "description": "The end of the validity window.", + "format": "date-time", + "nullable": true } - } + }, + "description": "The external-service price input data." }, - "QueryVouchersEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], + "CreateGlobalBillingSettingEndpoint_Input": { "type": "object", "properties": { - "total": { + "priority": { "type": "integer", - "format": "int64" + "description": "The priority of the setting. Defaults to the configured global default if not specified.", + "format": "int32", + "nullable": true }, - "page": { - "type": "integer", - "format": "int32" + "validFrom": { + "type": "string", + "description": "The start of the validity window.", + "format": "date-time", + "nullable": true }, - "pageSize": { - "type": "integer", - "format": "int32" + "validTo": { + "type": "string", + "description": "The end of the validity window.", + "format": "date-time", + "nullable": true }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryVouchersEndpoint_Output" - } + "costPerResponseFreeText": { + "type": "number", + "description": "The cost per free text response.", + "format": "double", + "nullable": true }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "ReconciliationJobState": { - "enum": [ - "Pending", - "Running", - "Completed", - "Failed" - ] - }, - "ReconciliationTimestampMode": { - "enum": [ - "UseResponseCreatedAt", - "UseReconciliationTime" - ] - }, - "ResettleBillingPeriodEndpoint_Input": { - "type": "object", - "properties": { - "reopen": { - "type": "boolean", - "description": "Whether to undo an operator's close before re-settling, bringing the period's remaining\n amount back for review. Defaults to false, which leaves a closed period alone." - } - } - }, - "ResettleBillingPeriodEndpoint_Output": { - "required": [ - "billingPeriodId", - "status", - "skipped" - ], - "type": "object", - "properties": { - "billingPeriodId": { - "type": "string", - "description": "The re-settled billing period." + "costPerResponseImage": { + "type": "number", + "description": "The cost per image response.", + "format": "double", + "nullable": true }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/BillingPeriodStatus" - } - ], - "description": "The status the period is in after the call." + "costPerResponseMediaPerSecond": { + "type": "number", + "description": "The cost per second of media response.", + "format": "double", + "nullable": true }, - "netInvoiceableAmount": { + "costPerResponseMediaMinimum": { + "type": "number", + "description": "The minimum cost per media response.", + "format": "double", + "nullable": true + }, + "costPerResponseTextPer50Chars": { + "type": "number", + "description": "The cost per 50 characters of text response.", + "format": "double", + "nullable": true + }, + "costPerResponseContextTextPer50Chars": { + "type": "number", + "description": "The cost per 50 characters of context text.", + "format": "double", + "nullable": true + }, + "costPerResponseContextTextMinimum": { + "type": "number", + "description": "The minimum cost per context text.", + "format": "double", + "nullable": true + }, + "costPerResponseContextImage": { "type": "number", - "description": "What an invoice for this period would now charge.", + "description": "The cost per context image.", "format": "double", "nullable": true }, - "voucherCoverage": { + "costPerResponseContextVideoPerSecond": { "type": "number", - "description": "How much of the period's billable usage vouchers absorbed.", + "description": "The cost per second of context video.", "format": "double", "nullable": true }, - "settledAt": { - "type": "string", - "description": "When the period was settled by this call.", - "format": "date-time", + "costPerResponseContextVideoMinimum": { + "type": "number", + "description": "The minimum cost per context video.", + "format": "double", "nullable": true }, - "skipped": { - "type": "boolean", - "description": "Whether the period was left untouched." - }, - "skippedReason": { - "type": "string", - "description": "Why the period was left untouched, when it was.", - "nullable": true - } - } - }, - "SetMinimumSpendCommitmentEndpoint_Input": { - "required": [ - "minimumSpendCommitment" - ], - "type": "object", - "properties": { - "minimumSpendCommitment": { + "discountRatio": { "type": "number", - "description": "The new minimum spend commitment. 0 means no commitment; a positive value tops up\n the usage-side bill at invoice time when measured spend falls short.", - "format": "double" + "description": "The discount ratio (0-1, e.g. 0.10 = 10% off).", + "format": "double", + "nullable": true } - } + }, + "description": "The billing setting input data." }, - "SetOrganizationCreditLineEndpoint_Input": { + "CreateInvoiceEndpoint_Input": { "required": [ - "creditLine" + "billingPeriodId" ], "type": "object", "properties": { - "creditLine": { - "type": "number", - "description": "The new credit line. null means no limit (unlimited), 0 disables all traffic,\n and a positive value caps spend at that amount.", - "format": "double", - "nullable": true + "billingPeriodId": { + "type": "string", + "description": "The billing period to create an invoice for." } } }, - "SetPlatformFeeEndpoint_Input": { + "CreateInvoiceEndpoint_Output": { "required": [ - "platformFee" + "invoiceId" ], "type": "object", "properties": { - "platformFee": { - "type": "number", - "description": "The new platform fee. null removes the platform fee; 0 is an explicit $0\n fee that is still shown; a positive value is charged once per billing period.", - "format": "double", - "nullable": true + "invoiceId": { + "type": "string", + "description": "The created invoice ID." } } }, - "StartBulkReconciliationEndpoint_Input": { + "CreateManualChargeEndpoint_Input": { "required": [ - "organizationId" + "name", + "billingPeriodId", + "organizationId", + "reason" ], "type": "object", "properties": { - "billingItemId": { + "name": { "type": "string", - "description": "The identifier of a single billing item to reconcile.", - "nullable": true + "description": "The name of the manual charge." + }, + "billingPeriodId": { + "type": "string", + "description": "The billing period to add the charge to." }, "organizationId": { "type": "string", - "description": "The organization the reconciliation is scoped to." + "description": "The organization the charge is billed to." }, "customerId": { "type": "string", - "description": "The customer identifier to reconcile all billing items for.", + "description": "The member the charge is recorded against, for auditability. Optional — omit it for a\n charge that belongs to the organization as a whole rather than to one of its members.", "format": "uuid", "nullable": true }, - "billingGroupId": { + "customerMail": { "type": "string", - "description": "The billing group identifier to reconcile all billing items for.", + "description": "The email address of the member named by CustomerId.", "nullable": true }, - "startDate": { - "type": "string", - "description": "Optional start date filter. Only applies with CustomerId or BillingGroupId.", - "format": "date-time", + "amount": { + "type": "number", + "description": "The total charge amount, equivalent to a single unit priced at this value. Only\n honored when both Quantity and UnitPrice are omitted;\n never combine it with them.", + "format": "double", + "nullable": true, + "deprecated": true + }, + "quantity": { + "type": "integer", + "description": "The number of units billed. The charge total is Quantity × UnitPrice, and the\n invoice line shows the unit breakdown.", + "format": "int32", "nullable": true }, - "endDate": { - "type": "string", - "description": "Optional end date filter. Only applies with CustomerId or BillingGroupId.", - "format": "date-time", + "unitPrice": { + "type": "number", + "description": "The price per unit. Positive for fees, negative for refunds.", + "format": "double", "nullable": true }, - "timestampMode": { + "reason": { "allOf": [ { - "$ref": "#/components/schemas/ReconciliationTimestampMode" + "$ref": "#/components/schemas/ManualChargeReason" } ], - "description": "Controls the timestamp used for correction entries." - } - } - }, - "StartBulkReconciliationEndpoint_Output": { - "required": [ - "bulkReconciliationId" - ], - "type": "object", - "properties": { - "bulkReconciliationId": { - "type": "string", - "description": "The bulk reconciliation identifier for all jobs created in this bulk operation." + "description": "The reason for the manual charge." }, - "correlationId": { + "comment": { "type": "string", - "description": "The correlation identifier for all jobs created in this bulk operation.", - "nullable": true, - "deprecated": true + "description": "An optional comment describing the charge.", + "nullable": true } } }, - "TimeGrouping": { - "enum": [ - "Hour", - "Day", - "Week", - "Month", - "Minute" - ], - "description": "The time interval used to aggregate a time series." - }, - "VoucherSource": { - "enum": [ - "Signup", - "ManualGrant", - "TopUp", - "WriteOff" - ] - }, - "VoucherStatus": { - "enum": [ - "Active", - "Exhausted", - "Expired", - "Revoked" - ] - }, - "GetPipelineByIdEndpoint_Output": { + "CreateManualChargeEndpoint_Output": { "required": [ - "artifacts", - "featureFlags" + "id" ], "type": "object", "properties": { - "artifacts": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IArtifact" - } - } - ], - "description": "The artifacts attached to the pipeline, keyed by their role." - }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - } - ], - "description": "The feature flags enabled for the pipeline." + "id": { + "type": "string", + "description": "The ID of the created billing item." } } }, - "IArtifact": { - "required": [ - "_t" - ], + "CreateOrganizationBillingSettingEndpoint_Input": { "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IArtifactCampaignArtifact" - }, - { - "$ref": "#/components/schemas/IArtifactDatasetArtifact" - }, - { - "$ref": "#/components/schemas/IArtifactFileArtifact" - }, - { - "$ref": "#/components/schemas/IArtifactWorkflowArtifact" - }, - { - "$ref": "#/components/schemas/IArtifactWorkflowConfigArtifact" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "CampaignArtifactModel": "#/components/schemas/IArtifactCampaignArtifact", - "DatasetArtifactModel": "#/components/schemas/IArtifactDatasetArtifact", - "FileArtifactModel": "#/components/schemas/IArtifactFileArtifact", - "WorkflowArtifactModel": "#/components/schemas/IArtifactWorkflowArtifact", - "WorkflowConfigArtifactModel": "#/components/schemas/IArtifactWorkflowConfigArtifact" - } - } - }, - "IArtifactCampaignArtifact": { - "required": [ - "campaignId", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CampaignArtifactModel" - ], - "type": "string" - }, - "campaignId": { - "type": "string" - }, - "identifier": { - "type": "string" - } - } - }, - "IArtifactDatasetArtifact": { - "required": [ - "datasetId", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "DatasetArtifactModel" - ], - "type": "string" - }, - "datasetId": { - "type": "string" - }, - "identifier": { - "type": "string" - } - } - }, - "IArtifactFileArtifact": { - "required": [ - "fileName", - "identifier", - "_t" - ], "properties": { - "_t": { - "enum": [ - "FileArtifactModel" - ], - "type": "string" - }, - "fileName": { - "type": "string" + "priority": { + "type": "integer", + "description": "The priority of the setting. Defaults to the configured organization default if not specified.", + "format": "int32", + "nullable": true }, - "identifier": { - "type": "string" - } - } - }, - "IArtifactWorkflowArtifact": { - "required": [ - "workflowId", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "WorkflowArtifactModel" - ], - "type": "string" + "validFrom": { + "type": "string", + "description": "The start of the validity window.", + "format": "date-time", + "nullable": true }, - "workflowId": { - "type": "string" + "validTo": { + "type": "string", + "description": "The end of the validity window.", + "format": "date-time", + "nullable": true }, - "identifier": { - "type": "string" - } - } - }, - "IArtifactWorkflowConfigArtifact": { - "required": [ - "workflowConfig", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "WorkflowConfigArtifactModel" - ], - "type": "string" + "costPerResponseFreeText": { + "type": "number", + "description": "The cost per free text response.", + "format": "double", + "nullable": true }, - "workflowConfig": { - "$ref": "#/components/schemas/IWorkflowConfig" + "costPerResponseImage": { + "type": "number", + "description": "The cost per image response.", + "format": "double", + "nullable": true }, - "identifier": { - "type": "string" - } - } - }, - "IPipelineAsset": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineAssetPipelineFileAsset" + "costPerResponseMediaPerSecond": { + "type": "number", + "description": "The cost per second of media response.", + "format": "double", + "nullable": true }, - { - "$ref": "#/components/schemas/IPipelineAssetPipelineMultiAsset" + "costPerResponseMediaMinimum": { + "type": "number", + "description": "The minimum cost per media response.", + "format": "double", + "nullable": true }, - { - "$ref": "#/components/schemas/IPipelineAssetPipelineNullAsset" + "costPerResponseTextPer50Chars": { + "type": "number", + "description": "The cost per 50 characters of text response.", + "format": "double", + "nullable": true }, - { - "$ref": "#/components/schemas/IPipelineAssetPipelineTextAsset" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FileAsset": "#/components/schemas/IPipelineAssetPipelineFileAsset", - "MultiAsset": "#/components/schemas/IPipelineAssetPipelineMultiAsset", - "NullAsset": "#/components/schemas/IPipelineAssetPipelineNullAsset", - "TextAsset": "#/components/schemas/IPipelineAssetPipelineTextAsset" - } - } - }, - "IPipelineAssetPipelineFileAsset": { - "required": [ - "fileName", - "metadata", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FileAsset" - ], - "type": "string" + "costPerResponseContextTextPer50Chars": { + "type": "number", + "description": "The cost per 50 characters of context text.", + "format": "double", + "nullable": true }, - "fileName": { - "type": "string" + "costPerResponseContextTextMinimum": { + "type": "number", + "description": "The minimum cost per context text.", + "format": "double", + "nullable": true }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } - } - } - }, - "IPipelineAssetPipelineMultiAsset": { - "required": [ - "assets", - "metadata", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "MultiAsset" - ], - "type": "string" + "costPerResponseContextImage": { + "type": "number", + "description": "The cost per context image.", + "format": "double", + "nullable": true }, - "assets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IPipelineAsset" - } + "costPerResponseContextVideoPerSecond": { + "type": "number", + "description": "The cost per second of context video.", + "format": "double", + "nullable": true }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } - } - } - }, - "IPipelineAssetPipelineNullAsset": { - "required": [ - "metadata", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NullAsset" - ], - "type": "string" + "costPerResponseContextVideoMinimum": { + "type": "number", + "description": "The minimum cost per context video.", + "format": "double", + "nullable": true }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } + "discountRatio": { + "type": "number", + "description": "The discount ratio (0-1, e.g. 0.10 = 10% off).", + "format": "double", + "nullable": true } - } + }, + "description": "The billing setting input data." }, - "IPipelineAssetPipelineTextAsset": { + "CreateTopUpEndpoint_Input": { "required": [ - "text", - "metadata", - "_t" + "amount" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "TextAsset" - ], - "type": "string" - }, - "text": { - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineMetadata" - } + "amount": { + "type": "number", + "description": "The amount in dollars to add to the prepaid balance.", + "format": "double" } } }, - "IPipelineMetadata": { + "CreateTopUpEndpoint_Output": { "required": [ - "_t" + "url" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineClassificationMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineCountMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineDurationMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineFileTypeMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineImageDimensionMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineLocationMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineOriginalFilenameMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineSourceUrlMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineStreamsMetadata" - }, - { - "$ref": "#/components/schemas/IPipelineMetadataPipelineTextMetadata" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassificationMetadata": "#/components/schemas/IPipelineMetadataPipelineClassificationMetadata", - "CountMetadata": "#/components/schemas/IPipelineMetadataPipelineCountMetadata", - "DurationMetadata": "#/components/schemas/IPipelineMetadataPipelineDurationMetadata", - "FileTypeMetadata": "#/components/schemas/IPipelineMetadataPipelineFileTypeMetadata", - "ImageDimensionMetadata": "#/components/schemas/IPipelineMetadataPipelineImageDimensionMetadata", - "LocationMetadata": "#/components/schemas/IPipelineMetadataPipelineLocationMetadata", - "OriginalFilenameMetadata": "#/components/schemas/IPipelineMetadataPipelineOriginalFilenameMetadata", - "SourceUrlMetadata": "#/components/schemas/IPipelineMetadataPipelineSourceUrlMetadata", - "StreamsMetadata": "#/components/schemas/IPipelineMetadataPipelineStreamsMetadata", - "TextMetadata": "#/components/schemas/IPipelineMetadataPipelineTextMetadata" - } - } - }, - "IPipelineMetadataPipelineClassificationMetadata": { - "required": [ - "classification", - "visibilities", - "_t" - ], "properties": { - "_t": { - "enum": [ - "ClassificationMetadata" - ], - "type": "string" - }, - "classification": { - "type": "string" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "url": { + "type": "string", + "description": "The hosted Stripe checkout url to redirect the customer to." } } }, - "IPipelineMetadataPipelineCountMetadata": { + "CreateVolumeDiscountEndpoint_Input": { "required": [ - "visibilities", - "_t" + "minResponses", + "discountRatio" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "CountMetadata" - ], - "type": "string" - }, - "count": { + "minResponses": { "type": "integer", - "format": "int32" + "description": "The minimum number of responses to trigger this discount bracket.", + "format": "int64" }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "discountRatio": { + "type": "number", + "description": "The discount ratio for this bracket (e.g., 0.10 for 10%).", + "format": "double" } } }, - "IPipelineMetadataPipelineDurationMetadata": { + "CreateVolumeDiscountEndpoint_Output": { "required": [ - "duration", - "visibilities", - "_t" + "id" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "DurationMetadata" - ], - "type": "string" - }, - "duration": { + "id": { "type": "string", - "format": "date-time" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "description": "The ID of the created volume discount bracket." } } }, - "IPipelineMetadataPipelineFileTypeMetadata": { + "ExternalServiceKind": { + "enum": [ + "ContextShortening", + "ImageGeneration" + ] + }, + "GetActiveBillingPeriodOverviewEndpoint_Output": { "required": [ - "fileType", - "visibilities", - "_t" + "id", + "organizationId", + "startDate", + "endDate", + "status", + "totalGrossCost", + "totalDiscount", + "totalNetCost", + "totalResponseCount", + "lineItems" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FileTypeMetadata" - ], - "type": "string" + "id": { + "type": "string", + "description": "The billing period ID." }, - "fileType": { - "$ref": "#/components/schemas/FileType" + "organizationId": { + "type": "string", + "description": "The organization the billing period belongs to." }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelineMetadataPipelineImageDimensionMetadata": { - "required": [ - "visibilities", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ImageDimensionMetadata" + "startDate": { + "type": "string", + "description": "The start date of the billing period.", + "format": "date-time" + }, + "endDate": { + "type": "string", + "description": "The end date of the billing period.", + "format": "date-time" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/BillingPeriodStatus" + } ], - "type": "string" + "description": "The status of the billing period." }, - "height": { - "type": "integer", - "format": "int32" + "totalGrossCost": { + "type": "number", + "description": "The total gross cost before discounts.", + "format": "double" }, - "width": { + "totalDiscount": { + "type": "number", + "description": "The total discount amount.", + "format": "double" + }, + "totalNetCost": { + "type": "number", + "description": "The total net cost after discounts.", + "format": "double" + }, + "totalResponseCount": { "type": "integer", - "format": "int32" + "description": "The total number of billable responses.", + "format": "int64" }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "lineItems": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/ILineItem" + } + } + ], + "description": "The line items (running cost, platform fees, refunds, volume discounts)." } } }, - "IPipelineMetadataPipelineLocationMetadata": { + "GetBillingPeriodOverviewEndpoint_Output": { "required": [ - "visibilities", - "_t" + "id", + "organizationId", + "startDate", + "endDate", + "status", + "totalGrossCost", + "totalDiscount", + "totalNetCost", + "totalResponseCount", + "settlementStale", + "lineItems" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LocationMetadata" + "id": { + "type": "string", + "description": "The billing period ID." + }, + "organizationId": { + "type": "string", + "description": "The organization the billing period belongs to." + }, + "startDate": { + "type": "string", + "description": "The start date of the billing period.", + "format": "date-time" + }, + "endDate": { + "type": "string", + "description": "The end date of the billing period.", + "format": "date-time" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/BillingPeriodStatus" + } ], - "type": "string" + "description": "The status of the billing period." }, - "x": { + "totalGrossCost": { "type": "number", - "format": "float" + "description": "The total gross cost before discounts.", + "format": "double" }, - "y": { + "totalDiscount": { "type": "number", - "format": "float" + "description": "The total discount amount.", + "format": "double" }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "totalNetCost": { + "type": "number", + "description": "The total net cost after discounts.", + "format": "double" + }, + "totalResponseCount": { + "type": "integer", + "description": "The total number of billable responses.", + "format": "int64" + }, + "totalNonBillableCost": { + "type": "number", + "description": "The gross cost of the period's non-billable activity, if it was requested.", + "format": "double", + "nullable": true + }, + "totalNonBillableResponseCount": { + "type": "integer", + "description": "The total number of non-billable responses, if it was requested.", + "format": "int64", + "nullable": true + }, + "netInvoiceableAmount": { + "type": "number", + "description": "What an invoice for this period would charge, as of the last settlement: usage net of\n discounts plus charges, minus the voucher coverage already booked. Null until the period has\n been settled.", + "format": "double", + "nullable": true + }, + "voucherCoverage": { + "type": "number", + "description": "How much of the period's billable usage vouchers absorbed at the last settlement.", + "format": "double", + "nullable": true + }, + "settlementCurrency": { + "type": "string", + "description": "The currency the settlement amounts are denominated in.", + "nullable": true + }, + "settledAt": { + "type": "string", + "description": "When the period was last settled.", + "format": "date-time", + "nullable": true + }, + "settlementStale": { + "type": "boolean", + "description": "Whether a billing input changed after the settlement amounts were computed, so they are\n awaiting a recompute." + }, + "closedBy": { + "type": "string", + "description": "The operator who closed the period without invoicing it. Null when the period closed on\n its own because nothing was left to invoice.", + "nullable": true + }, + "closeReason": { + "type": "string", + "description": "Why the period was closed without being invoiced.", + "nullable": true + }, + "closedAt": { + "type": "string", + "description": "When the period was closed without being invoiced.", + "format": "date-time", + "nullable": true + }, + "lineItems": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/ILineItem" + } + } + ], + "description": "The line items (running cost, platform fees, refunds, volume discounts)." } } }, - "IPipelineMetadataPipelineOriginalFilenameMetadata": { + "GetBillingSettingsTimelineEndpoint_Output": { "required": [ - "originalFilename", - "visibilities", - "_t" + "intervals" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "OriginalFilenameMetadata" + "intervals": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBillingSettingsTimelineEndpoint_Output_Interval" + } + } ], - "type": "string" - }, - "originalFilename": { - "type": "string" - }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "description": "The billing settings intervals." } } }, - "IPipelineMetadataPipelineSourceUrlMetadata": { + "GetBillingSettingsTimelineEndpoint_Output_Interval": { "required": [ - "url", - "visibilities", - "_t" + "costPerResponseFreeText", + "costPerResponseImage", + "costPerResponseMediaPerSecond", + "costPerResponseMediaMinimum", + "costPerResponseTextPer50Chars", + "costPerResponseContextTextPer50Chars", + "costPerResponseContextTextMinimum", + "costPerResponseContextImage", + "costPerResponseContextVideoPerSecond", + "costPerResponseContextVideoMinimum", + "discountRatio" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "SourceUrlMetadata" - ], - "type": "string" + "from": { + "type": "string", + "format": "date-time", + "nullable": true }, - "url": { - "type": "string" + "to": { + "type": "string", + "format": "date-time", + "nullable": true }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "costPerResponseFreeText": { + "type": "number", + "format": "double" + }, + "costPerResponseImage": { + "type": "number", + "format": "double" + }, + "costPerResponseMediaPerSecond": { + "type": "number", + "format": "double" + }, + "costPerResponseMediaMinimum": { + "type": "number", + "format": "double" + }, + "costPerResponseTextPer50Chars": { + "type": "number", + "format": "double" + }, + "costPerResponseContextTextPer50Chars": { + "type": "number", + "format": "double" + }, + "costPerResponseContextTextMinimum": { + "type": "number", + "format": "double" + }, + "costPerResponseContextImage": { + "type": "number", + "format": "double" + }, + "costPerResponseContextVideoPerSecond": { + "type": "number", + "format": "double" + }, + "costPerResponseContextVideoMinimum": { + "type": "number", + "format": "double" + }, + "discountRatio": { + "type": "number", + "format": "double" } } }, - "IPipelineMetadataPipelineStreamsMetadata": { + "GetBillingSummaryEndpoint_Output": { "required": [ - "visibilities", - "_t" + "mode", + "currentPeriodUsage", + "minimumSpendCommitment" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "StreamsMetadata" + "mode": { + "allOf": [ + { + "$ref": "#/components/schemas/BillingSummaryMode" + } ], - "type": "string" + "description": "How the billing summary should be presented (usage, limited, or prepaid)." }, - "hasAudio": { - "type": "boolean" + "currentPeriodUsage": { + "type": "number", + "description": "The accumulated billable spend in the current billing period.", + "format": "double" }, - "hasVideo": { - "type": "boolean" + "effectiveLimit": { + "type": "number", + "description": "The spending cap for the current period, or null when unlimited.", + "format": "double", + "nullable": true }, - "hasSubtitles": { - "type": "boolean" + "availableAmount": { + "type": "number", + "description": "The remaining prepaid balance, set only for prepaid customers.", + "format": "double", + "nullable": true }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" + "minimumSpendCommitment": { + "type": "number", + "description": "Dollars the customer has committed to spend per billing period; 0 means no commitment.", + "format": "double" + }, + "platformFee": { + "type": "number", + "description": "The recurring fee charged once per billing period. null means no platform fee and\n no line item; 0 is an explicit $0 fee that is still itemized.", + "format": "double", + "nullable": true } } }, - "IPipelineMetadataPipelineTextMetadata": { + "GetBulkCloseBillingPeriodsStatusEndpoint_Output": { "required": [ - "visibilities", - "_t" + "bulkCloseId", + "state", + "dryRun", + "endedBefore", + "reason", + "expectedTotal", + "processed", + "succeeded", + "failed", + "writeOffAmount", + "createdAt", + "createdById", + "createdByMail", + "periods" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "TextMetadata" + "bulkCloseId": { + "type": "string", + "description": "The run this progress is about." + }, + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/BulkBillingPeriodCloseState" + } ], - "type": "string" + "description": "The state of the run, not a verdict on the periods it touched: Sweeping is queued or\n in progress, Completed means it reached the end of its selection and NOT that every\n period succeeded (read failed and each period's error for that), and\n Failed means the run itself died early with sweepError saying why." + }, + "dryRun": { + "type": "boolean", + "description": "Whether this run only reports what it would have written off." + }, + "endedBefore": { + "type": "string", + "description": "The selection's cut-off date.", + "format": "date-time" + }, + "maxNetInvoiceableAmount": { + "type": "number", + "description": "The selection's cap, or null when the run was uncapped.", + "format": "double", + "nullable": true + }, + "reason": { + "type": "string", + "description": "Why the remaining amounts will never be invoiced." + }, + "expectedTotal": { + "type": "integer", + "description": "How many periods matched the selection when the sweep started. Zero until it starts.", + "format": "int32" + }, + "processed": { + "type": "integer", + "description": "How many periods the run has reached so far.", + "format": "int32" + }, + "succeeded": { + "type": "integer", + "description": "How many periods were closed, or would be closed in a dry run.", + "format": "int32" + }, + "failed": { + "type": "integer", + "description": "How many periods were refused or failed. A non-zero count here does not stop the run, and\n does not make its state Failed.", + "format": "int32" + }, + "writeOffAmount": { + "type": "number", + "description": "The total written off so far, or the total that would be written off in a dry run.", + "format": "double" + }, + "sweepError": { + "type": "string", + "description": "Why the run itself stopped early, when it did. Set only for a run-level failure; a period\n the sweep refused leaves this null and reports itself in its own error.", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "When the run was requested.", + "format": "date-time" + }, + "createdById": { + "type": "string", + "description": "The operator accountable for the run, as recorded on every period it closes.", + "format": "uuid" + }, + "createdByMail": { + "type": "string", + "description": "The operator's mail address." }, - "text": { + "completedAt": { "type": "string", + "description": "When the run finished, whether it completed or failed. Null while it is still sweeping.", + "format": "date-time", "nullable": true }, - "visibilities": { - "$ref": "#/components/schemas/MetadataVisibilities" - } - } - }, - "IPipelinePairMakerConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig" - }, - { - "$ref": "#/components/schemas/IPipelinePairMakerConfigPipelineOnlinePairMakerConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FullPermutationPairMakerConfig": "#/components/schemas/IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig", - "OnlinePairMakerConfig": "#/components/schemas/IPipelinePairMakerConfigPipelineOnlinePairMakerConfig" - } - } - }, - "IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FullPermutationPairMakerConfig" + "periods": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetBulkCloseBillingPeriodsStatusEndpoint_Output_Period" + } + } ], - "type": "string" + "description": "One verdict per period the run has reached, oldest period first." } } }, - "IPipelinePairMakerConfigPipelineOnlinePairMakerConfig": { + "GetBulkCloseBillingPeriodsStatusEndpoint_Output_Period": { "required": [ - "randomMatchesRatio", - "totalComparisonBudget", - "_t" + "billingPeriodId", + "writeOffAmount" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "OnlinePairMakerConfig" - ], + "billingPeriodId": { "type": "string" }, - "randomMatchesRatio": { + "organizationId": { + "type": "string", + "nullable": true + }, + "writeOffAmount": { "type": "number", - "format": "float" + "format": "double" }, - "totalComparisonBudget": { - "type": "integer", - "format": "int32" + "error": { + "type": "string", + "nullable": true } } }, - "IPipelineRankingConfig": { + "GetBulkReconciliationStatusEndpoint_Output": { "required": [ - "_t" + "bulkReconciliationId", + "dispatchState", + "expectedTotal", + "totalJobs", + "pendingJobs", + "runningJobs", + "completedJobs", + "failedJobs", + "rapidsProcessed", + "rapidsUpdated", + "rapidsAlreadyCorrect", + "rapidsFailed", + "responsesProcessed", + "correctionsCreated", + "responsesAlreadyCorrect", + "responsesFailed", + "createdAt" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineRankingConfigPipelineBradleyTerryRankingConfig" - }, - { - "$ref": "#/components/schemas/IPipelineRankingConfigPipelineEloRankingConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BradleyTerryRankingConfig": "#/components/schemas/IPipelineRankingConfigPipelineBradleyTerryRankingConfig", - "EloRankingConfig": "#/components/schemas/IPipelineRankingConfigPipelineEloRankingConfig" - } - } - }, - "IPipelineRankingConfigPipelineBradleyTerryRankingConfig": { - "required": [ - "startingScore", - "_t" - ], "properties": { - "_t": { - "enum": [ - "BradleyTerryRankingConfig" + "bulkReconciliationId": { + "type": "string", + "description": "The bulk reconciliation identifier for the bulk operation." + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier for the bulk operation.", + "nullable": true, + "deprecated": true + }, + "dispatchState": { + "allOf": [ + { + "$ref": "#/components/schemas/BulkReconciliationDispatchState" + } ], - "type": "string" + "description": "The current dispatch state (Dispatching, Completed, Failed)." }, - "startingScore": { + "expectedTotal": { "type": "integer", + "description": "The expected total number of billing items to dispatch.", "format": "int32" - } - } - }, - "IPipelineRankingConfigPipelineEloRankingConfig": { - "required": [ - "startingElo", - "kFactor", - "scalingFactor", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "EloRankingConfig" - ], - "type": "string" }, - "startingElo": { + "dispatchCompletedAt": { + "type": "string", + "description": "The timestamp when dispatching finished. Null if still dispatching.", + "format": "date-time", + "nullable": true + }, + "totalJobs": { "type": "integer", + "description": "The total number of reconciliation jobs in this bulk operation.", "format": "int32" }, - "kFactor": { + "pendingJobs": { "type": "integer", + "description": "The number of jobs in Pending state.", "format": "int32" }, - "scalingFactor": { + "runningJobs": { "type": "integer", + "description": "The number of jobs in Running state.", "format": "int32" - } - } - }, - "IRefereeConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRefereeConfigBudgetRefereeConfig" }, - { - "$ref": "#/components/schemas/IRefereeConfigNaiveRefereeConfig" + "completedJobs": { + "type": "integer", + "description": "The number of jobs in Completed state.", + "format": "int32" }, - { - "$ref": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig" + "failedJobs": { + "type": "integer", + "description": "The number of jobs in Failed state.", + "format": "int32" }, - { - "$ref": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig" + "rapidsProcessed": { + "type": "integer", + "description": "The total number of rapids processed across all jobs.", + "format": "int32" }, - { - "$ref": "#/components/schemas/IRefereeConfigQuorumRefereeConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BudgetRefereeConfig": "#/components/schemas/IRefereeConfigBudgetRefereeConfig", - "NaiveRefereeConfig": "#/components/schemas/IRefereeConfigNaiveRefereeConfig", - "NeverEndingRefereeConfig": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig", - "ProbabilisticAttachCategoryRefereeConfig": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig", - "QuorumRefereeConfig": "#/components/schemas/IRefereeConfigQuorumRefereeConfig" - } - } - }, - "IRefereeConfigBudgetRefereeConfig": { - "required": [ - "totalBudget", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BudgetRefereeConfig" - ], - "type": "string" + "rapidsUpdated": { + "type": "integer", + "description": "The total number of rapids updated across all jobs.", + "format": "int32" }, - "totalBudget": { + "rapidsAlreadyCorrect": { "type": "integer", + "description": "The total number of rapids already correct across all jobs.", "format": "int32" }, - "totalServeBudget": { + "rapidsFailed": { "type": "integer", - "format": "int32", - "nullable": true - } - } - }, - "IRefereeConfigNaiveRefereeConfig": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NaiveRefereeConfig" - ], - "type": "string" + "description": "The total number of rapids that failed across all jobs.", + "format": "int32" }, - "responsesRequired": { + "responsesProcessed": { + "type": "integer", + "description": "The total number of responses processed across all jobs.", + "format": "int32" + }, + "correctionsCreated": { "type": "integer", + "description": "The total number of corrections created across all jobs.", "format": "int32" }, - "guessesRequired": { + "responsesAlreadyCorrect": { "type": "integer", - "format": "int32", - "deprecated": true + "description": "The total number of responses already correct across all jobs.", + "format": "int32" + }, + "responsesFailed": { + "type": "integer", + "description": "The total number of responses that failed across all jobs.", + "format": "int32" + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the bulk operation was created.", + "format": "date-time" + }, + "completedAt": { + "type": "string", + "description": "The timestamp when all jobs completed. Null if not fully complete.", + "format": "date-time", + "nullable": true } } }, - "IRefereeConfigNeverEndingRefereeConfig": { + "GetCheckoutSessionEndpoint_Output": { "required": [ - "_t" + "status" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NeverEndingRefereeConfig" - ], - "type": "string" + "status": { + "type": "string", + "description": "The current status of the checkout session." } } }, - "IRefereeConfigProbabilisticAttachCategoryRefereeConfig": { + "GetCostTimeSeriesEndpoint_CostDataPoint": { "required": [ - "threshold", - "maxVotes", - "_t" + "periodStart", + "grossCost", + "discount", + "netCost", + "responseCount" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ProbabilisticAttachCategoryRefereeConfig" - ], - "type": "string" + "periodStart": { + "type": "string", + "format": "date-time" }, - "threshold": { + "grossCost": { "type": "number", "format": "double" }, - "maxVotes": { - "type": "integer", - "format": "int32" - } - } - }, - "IRefereeConfigQuorumRefereeConfig": { - "required": [ - "maxVotes", - "threshold", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "QuorumRefereeConfig" - ], - "type": "string" + "discount": { + "type": "number", + "format": "double" }, - "maxVotes": { - "type": "integer", - "format": "int32" + "netCost": { + "type": "number", + "format": "double" }, - "threshold": { + "cost": { + "type": "number", + "format": "double", + "deprecated": true + }, + "responseCount": { "type": "integer", - "format": "int32" + "format": "int64" } } }, - "IWorkflowConfig": { + "GetCostTimeSeriesEndpoint_Output": { "required": [ - "_t" + "timeSeries", + "totalGrossCost", + "totalDiscount", + "totalNetCost" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IWorkflowConfigEvaluationWorkflowConfig" - }, - { - "$ref": "#/components/schemas/IWorkflowConfigGroupedRankingWorkflowConfig" - }, - { - "$ref": "#/components/schemas/IWorkflowConfigRankingWorkflowConfig" - }, - { - "$ref": "#/components/schemas/IWorkflowConfigSimpleWorkflowConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "EvaluationWorkflowConfig": "#/components/schemas/IWorkflowConfigEvaluationWorkflowConfig", - "GroupedRankingWorkflowConfig": "#/components/schemas/IWorkflowConfigGroupedRankingWorkflowConfig", - "RankingWorkflowConfig": "#/components/schemas/IWorkflowConfigRankingWorkflowConfig", - "SimpleWorkflowConfig": "#/components/schemas/IWorkflowConfigSimpleWorkflowConfig" - } - } - }, - "IWorkflowConfigEvaluationWorkflowConfig": { - "required": [ - "validationSetId", - "referee", - "shouldAcceptIncorrect", - "_t" - ], "properties": { - "_t": { - "enum": [ - "EvaluationWorkflowConfig" + "timeSeries": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetCostTimeSeriesEndpoint_CostDataPoint" + } + } ], - "type": "string" + "description": "The time series data points." }, - "validationSetId": { - "type": "string" + "totalGrossCost": { + "type": "number", + "description": "The total gross cost across all data points.", + "format": "double" }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" + "totalDiscount": { + "type": "number", + "description": "The total discount across all data points.", + "format": "double" }, - "shouldAcceptIncorrect": { - "type": "boolean" + "totalNetCost": { + "type": "number", + "description": "The total net cost across all data points.", + "format": "double" }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true + "totalCost": { + "type": "number", + "description": "Deprecated. Use TotalNetCost instead.", + "format": "double", + "deprecated": true } - } + }, + "description": "The output for the cost time series endpoint." }, - "IWorkflowConfigGroupedRankingWorkflowConfig": { + "GetInvoiceEndpoint_Output": { "required": [ - "criteria", - "referee", - "targetCountryCodes", - "maxParallelism", - "pairMakerConfig", - "_t" + "id", + "billingPeriodId", + "billingPeriodStart", + "billingPeriodEnd", + "status", + "amountDue", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "GroupedRankingWorkflowConfig" - ], - "type": "string" - }, - "criteria": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "targetCountryCodes": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "string", + "description": "The invoice ID." }, - "contexts": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "nullable": true, - "deprecated": true + "billingPeriodId": { + "type": "string", + "description": "The billing period this invoice belongs to." }, - "contextAssets": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IPipelineAsset" - }, - "nullable": true, - "deprecated": true + "billingPeriodStart": { + "type": "string", + "description": "The start date of the billing period.", + "format": "date-time" }, - "maxParallelism": { - "type": "integer", - "format": "int32" + "billingPeriodEnd": { + "type": "string", + "description": "The end date of the billing period.", + "format": "date-time" }, - "rankingConfig": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineRankingConfig" - } - ], + "stripeInvoiceId": { + "type": "string", + "description": "The Stripe invoice ID.", "nullable": true }, - "eloConfig": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/PipelineEloRankingConfig" + "$ref": "#/components/schemas/InvoiceStatus" } ], - "deprecated": true + "description": "The current invoice status." }, - "pairMakerConfig": { - "$ref": "#/components/schemas/IPipelinePairMakerConfig" + "amountDue": { + "type": "integer", + "description": "The total amount due in cents.", + "format": "int64" }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, + "currency": { + "type": "string", + "description": "The invoice currency.", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "When the invoice was created.", + "format": "date-time" + }, + "finalizedAt": { + "type": "string", + "description": "When the invoice was finalized.", + "format": "date-time", + "nullable": true + }, + "paidAt": { + "type": "string", + "description": "When the invoice was paid.", + "format": "date-time", "nullable": true } } }, - "IWorkflowConfigRankingWorkflowConfig": { + "GetReconciliationStatusEndpoint_Output": { "required": [ - "criteria", - "referee", - "pairMakerConfig", - "_t" + "jobId", + "billingId", + "state", + "timestampMode", + "rapidsProcessed", + "rapidsUpdated", + "rapidsAlreadyCorrect", + "rapidsFailed", + "responsesProcessed", + "correctionsCreated", + "responsesAlreadyCorrect", + "responsesFailed", + "createdAt", + "createdById", + "createdByMail" ], - "properties": { - "_t": { - "enum": [ - "RankingWorkflowConfig" - ], - "type": "string" - }, - "criteria": { - "type": "string" + "type": "object", + "properties": { + "jobId": { + "type": "string", + "description": "The unique identifier of the reconciliation job." }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" + "billingId": { + "type": "string", + "description": "The billing item identifier this job reconciles." }, - "context": { + "bulkReconciliationId": { "type": "string", + "description": "The bulk reconciliation identifier if this job was created as part of a bulk operation.", "nullable": true }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPipelineAsset" - } - ], - "nullable": true + "correlationId": { + "type": "string", + "description": "The correlation identifier if this job was created as part of a bulk operation.", + "nullable": true, + "deprecated": true }, - "rankingConfig": { - "type": "object", - "oneOf": [ + "state": { + "allOf": [ { - "$ref": "#/components/schemas/IPipelineRankingConfig" + "$ref": "#/components/schemas/ReconciliationJobState" } ], - "nullable": true + "description": "The current state of the reconciliation job." }, - "eloConfig": { + "timestampMode": { "allOf": [ { - "$ref": "#/components/schemas/PipelineEloRankingConfig" + "$ref": "#/components/schemas/ReconciliationTimestampMode" } ], - "deprecated": true + "description": "The timestamp mode used for correction entries." }, - "pairMakerConfig": { - "$ref": "#/components/schemas/IPipelinePairMakerConfig" + "rapidsProcessed": { + "type": "integer", + "description": "The total number of rapids processed.", + "format": "int32" }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - } - }, - "IWorkflowConfigSimpleWorkflowConfig": { - "required": [ - "referee", - "blueprint", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "SimpleWorkflowConfig" - ], - "type": "string" + "rapidsUpdated": { + "type": "integer", + "description": "The number of rapids that were updated.", + "format": "int32" }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" + "rapidsAlreadyCorrect": { + "type": "integer", + "description": "The number of rapids that were already correct.", + "format": "int32" }, - "blueprint": { - "$ref": "#/components/schemas/IRapidBlueprint" + "rapidsFailed": { + "type": "integer", + "description": "The number of rapids that failed during reconciliation.", + "format": "int32" }, - "batchSize": { + "responsesProcessed": { "type": "integer", - "format": "int32", - "nullable": true + "description": "The total number of responses processed.", + "format": "int32" }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - } - }, - "PipelineEloRankingConfig": { - "required": [ - "startingElo", - "kFactor", - "scalingFactor" - ], - "type": "object", - "properties": { - "startingElo": { + "correctionsCreated": { "type": "integer", + "description": "The number of correction entries created.", "format": "int32" }, - "kFactor": { + "responsesAlreadyCorrect": { "type": "integer", + "description": "The number of responses that were already correct.", "format": "int32" }, - "scalingFactor": { + "responsesFailed": { "type": "integer", + "description": "The number of responses that failed during reconciliation.", "format": "int32" - } - } - }, - "StartPreliminaryDownloadEndpoint_Input": { - "type": "object", - "properties": { - "sendEmail": { - "type": "boolean", - "description": "Whether to email the user when the download is ready." - } - } - }, - "StartPreliminaryDownloadEndpoint_Output": { - "required": [ - "downloadId" - ], - "type": "object", - "properties": { - "downloadId": { + }, + "errorMessage": { + "type": "string", + "description": "The error message if the job failed.", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "The timestamp when the job completed.", + "format": "date-time", + "nullable": true + }, + "createdAt": { + "type": "string", + "description": "The timestamp when the job was created.", + "format": "date-time" + }, + "createdById": { + "type": "string", + "description": "The identifier of the user who created the job.", + "format": "uuid" + }, + "createdByMail": { "type": "string", - "description": "The id of the preliminary download that was initiated." + "description": "The email of the user who created the job." } } }, - "AddUserResponseEndpoint_Input": { + "GetVolumeDiscountsEndpoint_Output": { "required": [ - "sessionIndex", - "result" + "items" ], "type": "object", "properties": { - "sessionIndex": { - "type": "integer", - "description": "The index of the session when the result was submitted.", - "format": "int32" - }, - "result": { + "items": { "allOf": [ { - "$ref": "#/components/schemas/IRapidResult" + "type": "array", + "items": { + "$ref": "#/components/schemas/GetVolumeDiscountsEndpoint_Output_VolumeDiscountItem" + } } ], - "description": "The result submitted by the user." + "description": "The volume discount brackets." } } }, - "AddUserResponseEndpoint_Output": { + "GetVolumeDiscountsEndpoint_Output_VolumeDiscountItem": { "required": [ - "isAccepted", - "userScore" + "id", + "minResponses", + "discountRatio" ], "type": "object", "properties": { - "isAccepted": { - "type": "boolean", - "description": "Whether the response was accepted." - }, - "validationTruth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The validation truth applied to the response, if any." + "id": { + "type": "string" }, - "explanation": { - "allOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "description": "An optional translated explanation for the user." + "minResponses": { + "type": "integer", + "format": "int64" }, - "userScore": { + "discountRatio": { "type": "number", - "description": "The user's score after processing this response.", "format": "double" - }, - "nextRapid": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapid" - } - ], - "description": "The next rapid to solve when the session streams its rapids and continues.\n Null when there is nothing further to solve." } } }, - "AttachCategoryRapid_Category": { + "GrantVoucherEndpoint_Input": { "required": [ - "value", - "label" + "organizationId", + "amount" ], "type": "object", "properties": { - "value": { - "type": "string" + "organizationId": { + "type": "string", + "description": "The id of the organization to grant the voucher to." }, - "label": { - "$ref": "#/components/schemas/TranslatedString" + "amount": { + "type": "number", + "description": "The face value of the voucher in dollars.", + "format": "double" + }, + "validity": { + "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", + "type": "string", + "description": "How long the voucher stays valid, counted from now. Serialized as a duration string in\n the format [days.]hh:mm:ss (the days part is optional): \"30.00:00:00\" = 30\n days, \"7.00:00:00\" = 7 days, \"12:00:00\" = 12 hours. Must be positive.\n Provide this or expiresAt, not both.", + "nullable": true + }, + "expiresAt": { + "type": "string", + "description": "An explicit expiry instant as an ISO-8601 timestamp (e.g. \"2026-12-31T23:59:59Z\").\n Use this instead of validity when you know the exact date the\n voucher should expire. Provide this or validity, not both.", + "format": "date-time", + "nullable": true } } }, - "ClassifyPayload": { + "GrantVoucherEndpoint_Output": { "required": [ - "categories", - "title" + "voucherId" ], "type": "object", "properties": { - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ClassifyPayload_Category" - } - }, - "title": { - "type": "string" + "voucherId": { + "type": "string", + "description": "The id of the granted voucher." } } }, - "CreateDemographicRapidEndpoint_Input": { + "IBillingGroup": { "required": [ - "key", - "payload" + "_t" ], "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The identifier of the demographic classification." + "oneOf": [ + { + "$ref": "#/components/schemas/IBillingGroupAudienceDistillationBillingGroup" }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/ClassifyPayload" - } - ], - "description": "The payload for the classification." + { + "$ref": "#/components/schemas/IBillingGroupAudienceJobBillingGroup" }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - ], - "description": "Optional feature flags to apply to the rapid." + { + "$ref": "#/components/schemas/IBillingGroupBenchmarkBillingGroup" }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "An optional asset to associate with the rapid." + { + "$ref": "#/components/schemas/IBillingGroupOrderBillingGroup" }, - "context": { - "type": "string", - "description": "An optional text context to show to the user.", - "nullable": true + { + "$ref": "#/components/schemas/IBillingGroupRankingFlowBillingGroup" }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "An optional asset to use as context to show to the user." + { + "$ref": "#/components/schemas/IBillingGroupValidationSetBillingGroup" } - } - }, - "CreateDemographicRapidEndpoint_Output": { - "required": [ - "rapidId" ], - "type": "object", - "properties": { - "rapidId": { - "type": "string", - "description": "The id of the created rapid." + "description": "A billable group of responses on a billing period, identified by a discriminator.\n Implementations describe the source of the charges (order, benchmark, audience job, etc.).", + "discriminator": { + "propertyName": "_t", + "mapping": { + "AudienceDistillationBillingGroup": "#/components/schemas/IBillingGroupAudienceDistillationBillingGroup", + "AudienceJobBillingGroup": "#/components/schemas/IBillingGroupAudienceJobBillingGroup", + "BenchmarkBillingGroup": "#/components/schemas/IBillingGroupBenchmarkBillingGroup", + "OrderBillingGroup": "#/components/schemas/IBillingGroupOrderBillingGroup", + "RankingFlowBillingGroup": "#/components/schemas/IBillingGroupRankingFlowBillingGroup", + "ValidationSetBillingGroup": "#/components/schemas/IBillingGroupValidationSetBillingGroup" } } }, - "CreateGlobalTextEndpoint_Input": { + "IBillingGroupAudienceDistillationBillingGroup": { "required": [ - "key", - "englishText" + "id", + "name", + "grossCost", + "discount", + "netCost", + "responseCount", + "audienceId", + "_t" ], - "type": "object", "properties": { - "key": { - "type": "string", - "description": "The human-readable key used to look up the text from translations." + "_t": { + "enum": [ + "AudienceDistillationBillingGroup" + ], + "type": "string" }, - "englishText": { + "id": { "type": "string", - "description": "The English source text that all translations derive from." - } - } - }, - "CreateGlobalTextEndpoint_Output": { - "required": [ - "globalTextId" - ], - "type": "object", - "properties": { - "globalTextId": { + "description": "The unique identifier of the billing group." + }, + "name": { "type": "string", - "description": "The unique identifier of the created global text entry." - } - } - }, - "CreateValidationFeedbackEndpoint_Input": { - "required": [ - "feedback" - ], - "type": "object", - "properties": { - "feedback": { + "description": "A human-readable name for the billing group." + }, + "grossCost": { + "type": "number", + "description": "The gross cost of the responses in this group, before any discount.", + "format": "double" + }, + "discount": { + "type": "number", + "description": "The absolute discount applied to the gross cost.", + "format": "double" + }, + "netCost": { + "type": "number", + "description": "The net cost of the responses in this group after discount.", + "format": "double" + }, + "responseCount": { + "type": "integer", + "description": "The number of responses attributed to this billing group.", + "format": "int64" + }, + "audienceId": { "type": "string", - "description": "The feedback text." - } - } - }, - "GetAllGlobalTextsEndpoint_Output": { - "required": [ - "globalTexts" - ], - "type": "object", - "properties": { - "globalTexts": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetAllGlobalTextsEndpoint_Output_Item" - } - } - ], - "description": "The list of global text entries." + "description": "The identifier of the audience the distillation run was executed for." + }, + "nonBillableCost": { + "type": "number", + "description": "The gross cost of this group's non-billable activity, if it was requested.", + "format": "double", + "nullable": true + }, + "nonBillableResponseCount": { + "type": "integer", + "description": "The number of non-billable responses in this group, if it was requested.", + "format": "int64", + "nullable": true } - } + }, + "description": "A billing group for responses produced by an audience distillation run." }, - "GetAllGlobalTextsEndpoint_Output_Item": { + "IBillingGroupAudienceJobBillingGroup": { "required": [ "id", - "key", - "englishText" + "name", + "grossCost", + "discount", + "netCost", + "responseCount", + "jobId", + "audienceId", + "_t" ], - "type": "object", "properties": { - "id": { + "_t": { + "enum": [ + "AudienceJobBillingGroup" + ], "type": "string" }, - "key": { - "type": "string" + "id": { + "type": "string", + "description": "The unique identifier of the billing group." }, - "englishText": { - "type": "string" - } - } - }, - "GetGlobalResponsesEndpoint_Output": { - "required": [ - "responses" - ], - "type": "object", - "properties": { - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output_Response" - } - } - ], - "description": "The most recent public responses." + "name": { + "type": "string", + "description": "A human-readable name for the billing group." + }, + "grossCost": { + "type": "number", + "description": "The gross cost of the responses in this group, before any discount.", + "format": "double" + }, + "discount": { + "type": "number", + "description": "The absolute discount applied to the gross cost.", + "format": "double" + }, + "netCost": { + "type": "number", + "description": "The net cost of the responses in this group after discount.", + "format": "double" + }, + "responseCount": { + "type": "integer", + "description": "The number of responses attributed to this billing group.", + "format": "int64" + }, + "jobId": { + "type": "string", + "description": "The identifier of the audience job that produced the responses." + }, + "audienceId": { + "type": "string", + "description": "The identifier of the audience the job belongs to." + }, + "nonBillableCost": { + "type": "number", + "description": "The gross cost of this group's non-billable activity, if it was requested.", + "format": "double", + "nullable": true + }, + "nonBillableResponseCount": { + "type": "integer", + "description": "The number of non-billable responses in this group, if it was requested.", + "format": "int64", + "nullable": true } - } + }, + "description": "A billing group for responses produced by an audience job." }, - "GetGlobalResponsesEndpoint_Output_Response": { + "IBillingGroupBenchmarkBillingGroup": { "required": [ "id", - "userId", - "country" + "name", + "grossCost", + "discount", + "netCost", + "responseCount", + "benchmarkId", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string" - }, - "userId": { + "_t": { + "enum": [ + "BenchmarkBillingGroup" + ], "type": "string" }, - "country": { - "type": "string" + "id": { + "type": "string", + "description": "The unique identifier of the billing group." }, - "age": { + "name": { "type": "string", - "nullable": true + "description": "A human-readable name for the billing group." }, - "occupation": { + "grossCost": { + "type": "number", + "description": "The gross cost of the responses in this group, before any discount.", + "format": "double" + }, + "discount": { + "type": "number", + "description": "The absolute discount applied to the gross cost.", + "format": "double" + }, + "netCost": { + "type": "number", + "description": "The net cost of the responses in this group after discount.", + "format": "double" + }, + "responseCount": { + "type": "integer", + "description": "The number of responses attributed to this billing group.", + "format": "int64" + }, + "benchmarkId": { "type": "string", + "description": "The identifier of the benchmark that produced the responses." + }, + "nonBillableCost": { + "type": "number", + "description": "The gross cost of this group's non-billable activity, if it was requested.", + "format": "double", "nullable": true }, - "gender": { - "type": "string", + "nonBillableResponseCount": { + "type": "integer", + "description": "The number of non-billable responses in this group, if it was requested.", + "format": "int64", "nullable": true } - } + }, + "description": "A billing group for responses produced by a benchmark." }, - "GetRapidNavigationEndpoint_Card": { + "IBillingGroupOrderBillingGroup": { "required": [ - "rapidId", - "asset", - "state", - "payload", - "responses", - "totalResponseCount" + "id", + "name", + "grossCost", + "discount", + "netCost", + "responseCount", + "orderId", + "_t" ], - "type": "object", "properties": { - "rapidId": { + "_t": { + "enum": [ + "OrderBillingGroup" + ], "type": "string" }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "id": { + "type": "string", + "description": "The unique identifier of the billing group." }, - "state": { - "$ref": "#/components/schemas/RapidState" + "name": { + "type": "string", + "description": "A human-readable name for the billing group." }, - "payload": { - "$ref": "#/components/schemas/IRapidPayload" + "grossCost": { + "type": "number", + "description": "The gross cost of the responses in this group, before any discount.", + "format": "double" }, - "responses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Card_Response" - } + "discount": { + "type": "number", + "description": "The absolute discount applied to the gross cost.", + "format": "double" }, - "totalResponseCount": { + "netCost": { + "type": "number", + "description": "The net cost of the responses in this group after discount.", + "format": "double" + }, + "responseCount": { "type": "integer", + "description": "The number of responses attributed to this billing group.", "format": "int64" }, - "context": { + "orderId": { "type": "string", - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true + "description": "The identifier of the order that produced the responses." }, - "decisiveness": { + "nonBillableCost": { "type": "number", + "description": "The gross cost of this group's non-billable activity, if it was requested.", "format": "double", "nullable": true }, - "aggregation": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IResponseAggregation" - } - ], + "nonBillableResponseCount": { + "type": "integer", + "description": "The number of non-billable responses in this group, if it was requested.", + "format": "int64", "nullable": true } - } + }, + "description": "A billing group for responses produced by an order." }, - "GetRapidNavigationEndpoint_Card_Response": { + "IBillingGroupRankingFlowBillingGroup": { "required": [ "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" + "name", + "grossCost", + "discount", + "netCost", + "responseCount", + "flowId", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { + "_t": { + "enum": [ + "RankingFlowBillingGroup" + ], "type": "string" }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { + "id": { "type": "string", - "nullable": true + "description": "The unique identifier of the billing group." }, - "occupation": { + "name": { "type": "string", - "nullable": true + "description": "A human-readable name for the billing group." }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "grossCost": { + "type": "number", + "description": "The gross cost of the responses in this group, before any discount.", + "format": "double" }, - "result": { - "$ref": "#/components/schemas/IRapidResult" + "discount": { + "type": "number", + "description": "The absolute discount applied to the gross cost.", + "format": "double" }, - "userScore": { + "netCost": { "type": "number", + "description": "The net cost of the responses in this group after discount.", "format": "double" }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "GetRapidNavigationEndpoint_Item": { - "required": [ - "rapidId", - "asset", - "state" - ], - "type": "object", - "properties": { - "rapidId": { - "type": "string" + "responseCount": { + "type": "integer", + "description": "The number of responses attributed to this billing group.", + "format": "int64" }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "flowId": { + "type": "string", + "description": "The identifier of the ranking flow that produced the responses." }, - "state": { - "$ref": "#/components/schemas/RapidState" + "nonBillableCost": { + "type": "number", + "description": "The gross cost of this group's non-billable activity, if it was requested.", + "format": "double", + "nullable": true + }, + "nonBillableResponseCount": { + "type": "integer", + "description": "The number of non-billable responses in this group, if it was requested.", + "format": "int64", + "nullable": true } - } + }, + "description": "A billing group for responses produced by a ranking flow." }, - "GetRapidNavigationEndpoint_Output": { + "IBillingGroupValidationSetBillingGroup": { "required": [ - "current", - "previous", - "next", - "index", - "total" + "id", + "name", + "grossCost", + "discount", + "netCost", + "responseCount", + "validationSetId", + "_t" ], - "type": "object", "properties": { - "current": { - "allOf": [ - { - "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Card" - } + "_t": { + "enum": [ + "ValidationSetBillingGroup" ], - "description": "The anchor rapid, carrying the same fields a results-grid card renders." + "type": "string" }, - "previous": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Item" - } - } - ], - "description": "The rapids preceding the anchor in grid order, at most window entries,\n ordered ascending with the neighbour adjacent to the anchor last." + "id": { + "type": "string", + "description": "The unique identifier of the billing group." }, - "next": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Item" - } - } - ], - "description": "The rapids following the anchor in grid order, at most window entries,\n in ascending order." + "name": { + "type": "string", + "description": "A human-readable name for the billing group." }, - "index": { + "grossCost": { + "type": "number", + "description": "The gross cost of the responses in this group, before any discount.", + "format": "double" + }, + "discount": { + "type": "number", + "description": "The absolute discount applied to the gross cost.", + "format": "double" + }, + "netCost": { + "type": "number", + "description": "The net cost of the responses in this group after discount.", + "format": "double" + }, + "responseCount": { "type": "integer", - "description": "The 1-based position of the anchor within the filtered slice.", + "description": "The number of responses attributed to this billing group.", "format": "int64" }, - "total": { + "validationSetId": { + "type": "string", + "description": "The identifier of the validation set that produced the responses." + }, + "nonBillableCost": { + "type": "number", + "description": "The gross cost of this group's non-billable activity, if it was requested.", + "format": "double", + "nullable": true + }, + "nonBillableResponseCount": { "type": "integer", - "description": "The total number of rapids in the filtered slice.", - "format": "int64" + "description": "The number of non-billable responses in this group, if it was requested.", + "format": "int64", + "nullable": true } - } + }, + "description": "A billing group for responses produced by a validation set." }, - "GetResponsesForRapidEndpoint_Output": { + "ILineItem": { "required": [ - "rapidId", - "asset", - "responses", - "state" + "_t" ], "type": "object", - "properties": { - "rapidId": { - "type": "string", - "description": "The id of the rapid." + "oneOf": [ + { + "$ref": "#/components/schemas/ILineItemMinimumSpendCommitment" }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The asset of the rapid." + { + "$ref": "#/components/schemas/ILineItemOtherCharge" }, - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output_Response" - } - } - ], - "description": "The list of responses for the rapid." + { + "$ref": "#/components/schemas/ILineItemPlatformFee" }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidState" - } - ], - "description": "The state of the rapid." + { + "$ref": "#/components/schemas/ILineItemRefund" + }, + { + "$ref": "#/components/schemas/ILineItemRunningCost" + }, + { + "$ref": "#/components/schemas/ILineItemVolumeDiscount" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "MinimumSpendCommitment": "#/components/schemas/ILineItemMinimumSpendCommitment", + "Other": "#/components/schemas/ILineItemOtherCharge", + "PlatformFee": "#/components/schemas/ILineItemPlatformFee", + "Refund": "#/components/schemas/ILineItemRefund", + "RunningCost": "#/components/schemas/ILineItemRunningCost", + "VolumeDiscount": "#/components/schemas/ILineItemVolumeDiscount" } } }, - "GetResponsesForRapidEndpoint_Output_Response": { + "ILineItemMinimumSpendCommitment": { "required": [ - "id", - "userId", - "country", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" + "name", + "amount", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { + "_t": { + "enum": [ + "MinimumSpendCommitment" + ], "type": "string" }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { - "type": "string", - "nullable": true - }, - "occupation": { + "id": { "type": "string", "nullable": true }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" + "name": { + "type": "string" }, - "userScore": { + "amount": { "type": "number", "format": "double" }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "InspectReportEndpoint_Output": { - "type": "object", - "properties": { - "dump": { + "comment": { "type": "string", - "description": "The captured dump, if any.", "nullable": true } } }, - "IRapid": { + "ILineItemOtherCharge": { "required": [ + "id", + "name", + "amount", + "quantity", + "unitPrice", "_t" ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRapidAttachCategoryRapid" - }, - { - "$ref": "#/components/schemas/IRapidBoundingBoxRapid" - }, - { - "$ref": "#/components/schemas/IRapidCompareRapid" - }, - { - "$ref": "#/components/schemas/IRapidFreeTextRapid" + "properties": { + "_t": { + "enum": [ + "Other" + ], + "type": "string" }, - { - "$ref": "#/components/schemas/IRapidLineRapid" + "id": { + "type": "string" }, - { - "$ref": "#/components/schemas/IRapidLocateRapid" + "name": { + "type": "string" }, - { - "$ref": "#/components/schemas/IRapidNamedEntityRapid" + "amount": { + "type": "number", + "format": "double" }, - { - "$ref": "#/components/schemas/IRapidPolygonRapid" + "comment": { + "type": "string", + "nullable": true }, - { - "$ref": "#/components/schemas/IRapidScrubRapid" + "quantity": { + "type": "integer", + "format": "int32" }, - { - "$ref": "#/components/schemas/IRapidTranscriptionRapid" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "AttachCategoryRapidModel": "#/components/schemas/IRapidAttachCategoryRapid", - "BoundingBoxRapidModel": "#/components/schemas/IRapidBoundingBoxRapid", - "CompareRapidModel": "#/components/schemas/IRapidCompareRapid", - "FreeTextRapidModel": "#/components/schemas/IRapidFreeTextRapid", - "LineRapidModel": "#/components/schemas/IRapidLineRapid", - "LocateRapidModel": "#/components/schemas/IRapidLocateRapid", - "NamedEntityRapidModel": "#/components/schemas/IRapidNamedEntityRapid", - "PolygonRapidModel": "#/components/schemas/IRapidPolygonRapid", - "ScrubRapidModel": "#/components/schemas/IRapidScrubRapid", - "TranscriptionRapidModel": "#/components/schemas/IRapidTranscriptionRapid" + "unitPrice": { + "type": "number", + "format": "double" } } }, - "IRapidAttachCategoryRapid": { + "ILineItemPlatformFee": { "required": [ - "categories", - "title", - "asset", - "featureFlags", "id", + "name", + "amount", "_t" ], "properties": { "_t": { "enum": [ - "AttachCategoryRapidModel" + "PlatformFee" ], "type": "string" }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachCategoryRapid_Category" - } - }, - "title": { - "$ref": "#/components/schemas/TranslatedString" + "id": { + "type": "string" }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "name": { + "type": "string" }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true + "amount": { + "type": "number", + "format": "double" }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], + "comment": { + "type": "string", "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" } } }, - "IRapidBoundingBoxRapid": { + "ILineItemRefund": { "required": [ - "target", - "asset", - "featureFlags", "id", + "name", + "amount", + "quantity", + "unitPrice", "_t" ], "properties": { "_t": { "enum": [ - "BoundingBoxRapidModel" + "Refund" ], "type": "string" }, - "target": { - "$ref": "#/components/schemas/TranslatedString" + "id": { + "type": "string" }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "name": { + "type": "string" }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true + "amount": { + "type": "number", + "format": "double" }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], + "comment": { + "type": "string", "nullable": true }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } + "quantity": { + "type": "integer", + "format": "int32" }, - "id": { + "unitPrice": { + "type": "number", + "format": "double" + } + } + }, + "ILineItemRunningCost": { + "required": [ + "amount", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "RunningCost" + ], "type": "string" + }, + "amount": { + "type": "number", + "format": "double" } } }, - "IRapidCompareRapid": { + "ILineItemVolumeDiscount": { "required": [ - "criteria", - "asset", - "featureFlags", - "id", + "amount", + "effectiveDiscountRatio", "_t" ], "properties": { "_t": { "enum": [ - "CompareRapidModel" + "VolumeDiscount" ], "type": "string" }, - "criteria": { - "$ref": "#/components/schemas/TranslatedString" + "amount": { + "type": "number", + "format": "double" }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "effectiveDiscountRatio": { + "type": "number", + "format": "double" + } + } + }, + "InvoiceStatus": { + "enum": [ + "Generating", + "Draft", + "Open", + "Paid", + "Void", + "Uncollectible", + "Failed" + ] + }, + "ManualChargeReason": { + "enum": [ + "PlatformFee", + "Refund", + "Other", + "MinimumSpendCommitment" + ] + }, + "PagedResultOfIBillingGroup": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int64" }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true + "page": { + "type": "integer", + "format": "int32" }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true + "pageSize": { + "type": "integer", + "format": "int32" }, - "featureFlags": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/IBillingGroup" } }, - "id": { - "type": "string" + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "IRapidFreeTextRapid": { + "QueryBillingPeriodsEndpoint_Output": { "required": [ - "question", - "asset", - "featureFlags", "id", - "_t" + "organizationId", + "startDate", + "endDate", + "status", + "settlementStale", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "FreeTextRapidModel" - ], - "type": "string" + "id": { + "type": "string", + "description": "The billing period ID." }, - "question": { - "$ref": "#/components/schemas/TranslatedString" + "organizationId": { + "type": "string", + "description": "The organization the billing period belongs to." }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "startDate": { + "type": "string", + "description": "The start date of the billing period.", + "format": "date-time" }, - "context": { - "type": "object", - "oneOf": [ + "endDate": { + "type": "string", + "description": "The end date of the billing period.", + "format": "date-time" + }, + "status": { + "allOf": [ { - "$ref": "#/components/schemas/TranslatedString" + "$ref": "#/components/schemas/BillingPeriodStatus" } ], + "description": "The status of the billing period." + }, + "netInvoiceableAmount": { + "type": "number", + "description": "What an invoice for this period would charge, as of the last settlement. Null until the\n period has been settled.", + "format": "double", "nullable": true }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], + "voucherCoverage": { + "type": "number", + "description": "How much of the period's billable usage vouchers absorbed at the last settlement.", + "format": "double", "nullable": true }, - "featureFlags": { + "settlementCurrency": { + "type": "string", + "description": "The currency the settlement amounts are denominated in.", + "nullable": true + }, + "settledAt": { + "type": "string", + "description": "When the period was last settled.", + "format": "date-time", + "nullable": true + }, + "settlementStale": { + "type": "boolean", + "description": "Whether a billing input changed after the settlement amounts were computed." + }, + "createdAt": { + "type": "string", + "description": "The date the billing period was created.", + "format": "date-time" + } + } + }, + "QueryBillingPeriodsEndpoint_PagedResultOfOutput": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int64" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/QueryBillingPeriodsEndpoint_Output" } }, - "id": { - "type": "string" + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "IRapidLineRapid": { + "QueryCostsByCustomerEndpoint_Output": { "required": [ - "target", - "asset", - "featureFlags", - "id", - "_t" + "customerId", + "customerMail", + "grossCost", + "discount", + "netCost", + "responseCount" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LineRapidModel" - ], - "type": "string" + "customerId": { + "type": "string", + "description": "The customer identifier.", + "format": "uuid" }, - "target": { - "$ref": "#/components/schemas/TranslatedString" + "customerMail": { + "type": "string", + "description": "The customer email." }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "grossCost": { + "type": "number", + "description": "The gross cost for this customer (before discount).", + "format": "double" }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true + "discount": { + "type": "number", + "description": "The discount for this customer.", + "format": "double" }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true + "netCost": { + "type": "number", + "description": "The net cost for this customer (after discount).", + "format": "double" }, - "featureFlags": { + "cost": { + "type": "number", + "description": "Deprecated. Use NetCost instead.", + "format": "double", + "deprecated": true + }, + "responseCount": { + "type": "integer", + "description": "The total number of responses for this customer.", + "format": "int64" + } + }, + "description": "Billing cost data aggregated per customer." + }, + "QueryCostsByCustomerEndpoint_PagedResultOfOutput": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int64" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/QueryCostsByCustomerEndpoint_Output" } }, - "id": { - "type": "string" + "totalPages": { + "type": "integer", + "format": "int32" + } + } + }, + "QueryCostsByOrganizationEndpoint_Output": { + "required": [ + "organizationOwnerId", + "organizationName", + "grossCost", + "discount", + "netCost", + "responseCount" + ], + "type": "object", + "properties": { + "organizationOwnerId": { + "type": "string", + "description": "The organization owner identifier.", + "format": "uuid" + }, + "organizationName": { + "type": "string", + "description": "The organization name." + }, + "grossCost": { + "type": "number", + "description": "The gross cost for this organization (before discount).", + "format": "double" + }, + "discount": { + "type": "number", + "description": "The discount for this organization.", + "format": "double" + }, + "netCost": { + "type": "number", + "description": "The net cost for this organization (after discount).", + "format": "double" + }, + "cost": { + "type": "number", + "description": "Deprecated. Use NetCost instead.", + "format": "double", + "deprecated": true + }, + "responseCount": { + "type": "integer", + "description": "The total number of responses for this organization.", + "format": "int64" } - } + }, + "description": "Billing cost data aggregated per organization." }, - "IRapidLocateRapid": { + "QueryCostsByOrganizationEndpoint_PagedResultOfOutput": { "required": [ - "target", - "asset", - "featureFlags", - "id", - "_t" + "total", + "page", + "pageSize", + "items" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LocateRapidModel" - ], - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/TranslatedString" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "total": { + "type": "integer", + "format": "int64" }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true + "page": { + "type": "integer", + "format": "int32" }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true + "pageSize": { + "type": "integer", + "format": "int32" }, - "featureFlags": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/QueryCostsByOrganizationEndpoint_Output" } }, - "id": { - "type": "string" + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "IRapidNamedEntityRapid": { + "QueryInvoicesEndpoint_Output": { "required": [ - "target", - "classes", - "asset", - "featureFlags", "id", - "_t" + "billingPeriodId", + "billingPeriodStart", + "billingPeriodEnd", + "status", + "amountDue", + "organizationId", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NamedEntityRapidModel" - ], - "type": "string" + "id": { + "type": "string", + "description": "The invoice ID." }, - "target": { - "$ref": "#/components/schemas/TranslatedString" + "billingPeriodId": { + "type": "string", + "description": "The billing period this invoice belongs to." }, - "classes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranslatedString" - } + "billingPeriodStart": { + "type": "string", + "description": "The start date of the billing period.", + "format": "date-time" }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "billingPeriodEnd": { + "type": "string", + "description": "The end date of the billing period.", + "format": "date-time" }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], + "stripeInvoiceId": { + "type": "string", + "description": "The Stripe invoice ID.", "nullable": true }, - "contextAsset": { - "type": "object", - "oneOf": [ + "status": { + "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/InvoiceStatus" } ], - "nullable": true + "description": "The current invoice status." }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } + "amountDue": { + "type": "integer", + "description": "The total amount due in cents.", + "format": "int64" }, - "id": { - "type": "string" - } - } - }, - "IRapidPolygonRapid": { - "required": [ - "target", - "asset", - "featureFlags", - "id", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonRapidModel" - ], - "type": "string" + "currency": { + "type": "string", + "description": "The invoice currency.", + "nullable": true }, - "target": { - "$ref": "#/components/schemas/TranslatedString" + "organizationId": { + "type": "string", + "description": "The organization the invoice belongs to." }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "createdAt": { + "type": "string", + "description": "When the invoice was created.", + "format": "date-time" }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], + "finalizedAt": { + "type": "string", + "description": "When the invoice was finalized.", + "format": "date-time", "nullable": true }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], + "paidAt": { + "type": "string", + "description": "When the invoice was paid.", + "format": "date-time", "nullable": true }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" + "voidedAt": { + "type": "string", + "description": "When the invoice was voided.", + "format": "date-time", + "nullable": true } } }, - "IRapidScrubRapid": { + "QueryInvoicesEndpoint_PagedResultOfOutput": { "required": [ - "target", - "id", - "featureFlags", - "asset", - "_t" + "total", + "page", + "pageSize", + "items" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ScrubRapidModel" - ], - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/TranslatedString" - }, - "id": { - "type": "string" + "total": { + "type": "integer", + "format": "int64" }, - "context": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/TranslatedString" - } - ], - "nullable": true + "page": { + "type": "integer", + "format": "int32" }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true + "pageSize": { + "type": "integer", + "format": "int32" }, - "featureFlags": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/QueryInvoicesEndpoint_Output" } }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "IRapidTranscriptionRapid": { + "QueryVouchersEndpoint_Output": { "required": [ - "transcription", - "title", - "asset", - "featureFlags", "id", - "_t" + "amount", + "used", + "remaining", + "issuedAt", + "expiresAt", + "status", + "source" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "TranscriptionRapidModel" - ], - "type": "string" + "id": { + "type": "string", + "description": "The voucher id." }, - "transcription": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionRapid_TranscriptionWord" - } + "amount": { + "type": "number", + "description": "The face value of the voucher in dollars.", + "format": "double" }, - "title": { - "$ref": "#/components/schemas/TranslatedString" + "used": { + "type": "number", + "description": "The amount already consumed across closed billing periods.", + "format": "double" }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "remaining": { + "type": "number", + "description": "The remaining free usage the voucher can still grant.", + "format": "double" }, - "context": { - "type": "object", - "oneOf": [ + "issuedAt": { + "type": "string", + "description": "When the voucher was issued.", + "format": "date-time" + }, + "expiresAt": { + "type": "string", + "description": "When the voucher expires.", + "format": "date-time" + }, + "status": { + "allOf": [ { - "$ref": "#/components/schemas/TranslatedString" + "$ref": "#/components/schemas/VoucherStatus" } ], - "nullable": true + "description": "The voucher's lifecycle status." }, - "contextAsset": { - "type": "object", - "oneOf": [ + "source": { + "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/VoucherSource" } ], - "nullable": true - }, - "featureFlags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - } - }, - "id": { - "type": "string" + "description": "Where the voucher came from." } } }, - "IRefereeInfo": { + "QueryVouchersEndpoint_PagedResultOfOutput": { "required": [ - "_t" + "total", + "page", + "pageSize", + "items" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRefereeInfoNaiveRefereeInfo" - }, - { - "$ref": "#/components/schemas/IRefereeInfoNeverEndingRefereeInfo" - }, - { - "$ref": "#/components/schemas/IRefereeInfoProbabilisticAttachCategoryRefereeInfo" - }, - { - "$ref": "#/components/schemas/IRefereeInfoQuorumRefereeInfo" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "NaiveRefereeInfo": "#/components/schemas/IRefereeInfoNaiveRefereeInfo", - "NeverEndingRefereeInfo": "#/components/schemas/IRefereeInfoNeverEndingRefereeInfo", - "ProbabilisticAttachCategoryRefereeInfo": "#/components/schemas/IRefereeInfoProbabilisticAttachCategoryRefereeInfo", - "QuorumRefereeInfo": "#/components/schemas/IRefereeInfoQuorumRefereeInfo" - } - } - }, - "IRefereeInfoNaiveRefereeInfo": { - "required": [ - "_t" - ], "properties": { - "_t": { - "enum": [ - "NaiveRefereeInfo" - ], - "type": "string" + "total": { + "type": "integer", + "format": "int64" }, - "responseAmountThreshold": { + "page": { "type": "integer", "format": "int32" }, - "serveThreshold": { + "pageSize": { "type": "integer", - "format": "int32", - "nullable": true + "format": "int32" }, - "guessAmountThreshold": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryVouchersEndpoint_Output" + } + }, + "totalPages": { "type": "integer", - "format": "int32", - "deprecated": true + "format": "int32" } } }, - "IRefereeInfoNeverEndingRefereeInfo": { + "ReconciliationJobState": { + "enum": [ + "Pending", + "Running", + "Completed", + "Failed" + ] + }, + "ReconciliationTimestampMode": { + "enum": [ + "UseResponseCreatedAt", + "UseReconciliationTime" + ] + }, + "ResettleBillingPeriodEndpoint_Input": { + "type": "object", + "properties": { + "reopen": { + "type": "boolean", + "description": "Whether to undo an operator's close before re-settling, bringing the period's remaining\n amount back for review. Defaults to false, which leaves a closed period alone." + } + } + }, + "ResettleBillingPeriodEndpoint_Output": { "required": [ - "_t" + "billingPeriodId", + "status", + "skipped" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NeverEndingRefereeInfo" + "billingPeriodId": { + "type": "string", + "description": "The re-settled billing period." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/BillingPeriodStatus" + } ], - "type": "string" + "description": "The status the period is in after the call." + }, + "netInvoiceableAmount": { + "type": "number", + "description": "What an invoice for this period would now charge.", + "format": "double", + "nullable": true + }, + "voucherCoverage": { + "type": "number", + "description": "How much of the period's billable usage vouchers absorbed.", + "format": "double", + "nullable": true + }, + "settledAt": { + "type": "string", + "description": "When the period was settled by this call.", + "format": "date-time", + "nullable": true + }, + "skipped": { + "type": "boolean", + "description": "Whether the period was left untouched." + }, + "skippedReason": { + "type": "string", + "description": "Why the period was left untouched, when it was.", + "nullable": true } } }, - "IRefereeInfoProbabilisticAttachCategoryRefereeInfo": { + "SetMinimumSpendCommitmentEndpoint_Input": { "required": [ - "threshold", - "maxVotes", - "_t" + "minimumSpendCommitment" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ProbabilisticAttachCategoryRefereeInfo" - ], - "type": "string" - }, - "threshold": { + "minimumSpendCommitment": { "type": "number", + "description": "The new minimum spend commitment. 0 means no commitment; a positive value tops up\n the usage-side bill at invoice time when measured spend falls short.", "format": "double" - }, - "maxVotes": { - "type": "integer", - "format": "int32" } } }, - "IRefereeInfoQuorumRefereeInfo": { + "SetOrganizationCreditLineEndpoint_Input": { "required": [ - "maxVotes", - "threshold", - "_t" + "creditLine" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "QuorumRefereeInfo" - ], - "type": "string" - }, - "maxVotes": { - "type": "integer", - "format": "int32" - }, - "threshold": { - "type": "integer", - "format": "int32" + "creditLine": { + "type": "number", + "description": "The new credit line. null means no limit (unlimited), 0 disables all traffic,\n and a positive value caps spend at that amount.", + "format": "double", + "nullable": true } } }, - "IsRapidBagValidEndpoint_Output": { + "SetPlatformFeeEndpoint_Input": { "required": [ - "isValid" + "platformFee" ], "type": "object", "properties": { - "isValid": { - "type": "boolean", - "description": "Whether the rapid bag is valid." + "platformFee": { + "type": "number", + "description": "The new platform fee. null removes the platform fee; 0 is an explicit $0\n fee that is still shown; a positive value is charged once per billing period.", + "format": "double", + "nullable": true } } }, - "IValidationTruth": { + "StartBulkReconciliationEndpoint_Input": { "required": [ - "_t" + "organizationId" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IValidationTruthAttachCategoryTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthBoundingBoxTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthClassifyTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthCompareTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthEmptyValidationTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthLineTruth" - }, - { - "$ref": "#/components/schemas/IValidationTruthLocateBoxTruth" + "properties": { + "billingItemId": { + "type": "string", + "description": "The identifier of a single billing item to reconcile.", + "nullable": true }, - { - "$ref": "#/components/schemas/IValidationTruthMultiCompareTruth" + "organizationId": { + "type": "string", + "description": "The organization the reconciliation is scoped to." }, - { - "$ref": "#/components/schemas/IValidationTruthNamedEntityTruth" + "customerId": { + "type": "string", + "description": "The customer identifier to reconcile all billing items for.", + "format": "uuid", + "nullable": true }, - { - "$ref": "#/components/schemas/IValidationTruthPolygonTruth" + "billingGroupId": { + "type": "string", + "description": "The billing group identifier to reconcile all billing items for.", + "nullable": true }, - { - "$ref": "#/components/schemas/IValidationTruthScrubTruth" + "startDate": { + "type": "string", + "description": "Optional start date filter. Only applies with CustomerId or BillingGroupId.", + "format": "date-time", + "nullable": true }, - { - "$ref": "#/components/schemas/IValidationTruthSkipTruth" + "endDate": { + "type": "string", + "description": "Optional end date filter. Only applies with CustomerId or BillingGroupId.", + "format": "date-time", + "nullable": true }, - { - "$ref": "#/components/schemas/IValidationTruthTranscriptionTruth" + "timestampMode": { + "allOf": [ + { + "$ref": "#/components/schemas/ReconciliationTimestampMode" + } + ], + "description": "Controls the timestamp used for correction entries." } + } + }, + "StartBulkReconciliationEndpoint_Output": { + "required": [ + "bulkReconciliationId" ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "AttachCategoryTruth": "#/components/schemas/IValidationTruthAttachCategoryTruth", - "BoundingBoxTruth": "#/components/schemas/IValidationTruthBoundingBoxTruth", - "ClassifyTruth": "#/components/schemas/IValidationTruthClassifyTruth", - "CompareTruth": "#/components/schemas/IValidationTruthCompareTruth", - "EmptyValidationTruth": "#/components/schemas/IValidationTruthEmptyValidationTruth", - "LineTruth": "#/components/schemas/IValidationTruthLineTruth", - "LocateBoxTruth": "#/components/schemas/IValidationTruthLocateBoxTruth", - "MultiCompareTruth": "#/components/schemas/IValidationTruthMultiCompareTruth", - "NamedEntityTruth": "#/components/schemas/IValidationTruthNamedEntityTruth", - "PolygonTruth": "#/components/schemas/IValidationTruthPolygonTruth", - "ScrubTruth": "#/components/schemas/IValidationTruthScrubTruth", - "SkipTruth": "#/components/schemas/IValidationTruthSkipTruth", - "TranscriptionTruth": "#/components/schemas/IValidationTruthTranscriptionTruth" + "type": "object", + "properties": { + "bulkReconciliationId": { + "type": "string", + "description": "The bulk reconciliation identifier for all jobs created in this bulk operation." + }, + "correlationId": { + "type": "string", + "description": "The correlation identifier for all jobs created in this bulk operation.", + "nullable": true, + "deprecated": true } } }, - "IValidationTruthAttachCategoryTruth": { + "TimeGrouping": { + "enum": [ + "Hour", + "Day", + "Week", + "Month", + "Minute" + ], + "description": "The time interval used to aggregate a time series." + }, + "VoucherSource": { + "enum": [ + "Signup", + "ManualGrant", + "TopUp", + "WriteOff" + ] + }, + "VoucherStatus": { + "enum": [ + "Active", + "Exhausted", + "Expired", + "Revoked" + ] + }, + "AddUserResponseEndpoint_Input": { "required": [ - "correctCategories", - "_t" + "sessionIndex", + "result" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "AttachCategoryTruth" - ], - "type": "string" + "sessionIndex": { + "type": "integer", + "description": "The index of the session when the result was submitted.", + "format": "int32" }, - "correctCategories": { - "type": "array", - "items": { - "type": "string" - } + "result": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapidResult" + } + ], + "description": "The result submitted by the user." } } }, - "IValidationTruthBoundingBoxTruth": { + "AddUserResponseEndpoint_Output": { "required": [ - "xMin", - "yMin", - "xMax", - "yMax", - "_t" + "isAccepted", + "userScore" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "BoundingBoxTruth" - ], - "type": "string" + "isAccepted": { + "type": "boolean", + "description": "Whether the response was accepted." }, - "xMin": { - "type": "number", - "format": "double" + "validationTruth": { + "allOf": [ + { + "$ref": "#/components/schemas/IValidationTruth" + } + ], + "description": "The validation truth applied to the response, if any." }, - "yMin": { - "type": "number", - "format": "double" + "explanation": { + "allOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "description": "An optional translated explanation for the user." }, - "xMax": { + "userScore": { "type": "number", + "description": "The user's score after processing this response.", "format": "double" }, - "yMax": { - "type": "number", - "format": "double" + "nextRapid": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapid" + } + ], + "description": "The next rapid to solve when the session streams its rapids and continues.\n Null when there is nothing further to solve." } } }, - "IValidationTruthClassifyTruth": { + "AttachCategoryRapid_Category": { "required": [ - "correctCategories", - "_t" + "value", + "label" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ClassifyTruth" - ], + "value": { "type": "string" }, - "correctCategories": { - "type": "array", - "items": { - "type": "string" - } + "label": { + "$ref": "#/components/schemas/TranslatedString" } } }, - "IValidationTruthCompareTruth": { + "ClassifyPayload": { "required": [ - "winnerId", - "_t" + "categories", + "title" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "CompareTruth" - ], - "type": "string" + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ClassifyPayload_Category" + } }, - "winnerId": { + "title": { "type": "string" } } }, - "IValidationTruthEmptyValidationTruth": { + "CreateDemographicRapidEndpoint_Input": { "required": [ - "_t" + "key", + "payload" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "EmptyValidationTruth" + "key": { + "type": "string", + "description": "The identifier of the demographic classification." + }, + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/ClassifyPayload" + } ], - "type": "string" + "description": "The payload for the classification." + }, + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "Optional feature flags to apply to the rapid." + }, + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "An optional asset to associate with the rapid." + }, + "context": { + "type": "string", + "description": "An optional text context to show to the user.", + "nullable": true + }, + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "An optional asset to use as context to show to the user." } } }, - "IValidationTruthLineTruth": { + "CreateDemographicRapidEndpoint_Output": { "required": [ - "_t" + "rapidId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LineTruth" - ], - "type": "string" + "rapidId": { + "type": "string", + "description": "The id of the created rapid." } } }, - "IValidationTruthLocateBoxTruth": { + "CreateGlobalTextEndpoint_Input": { "required": [ - "boundingBoxes", - "_t" + "key", + "englishText" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LocateBoxTruth" - ], - "type": "string" - }, - "boundingBoxes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LocateBoxTruth_Box" - } - }, - "requiredPrecision": { - "type": "number", - "format": "double" + "key": { + "type": "string", + "description": "The human-readable key used to look up the text from translations." }, - "requiredCompleteness": { - "type": "number", - "format": "double" + "englishText": { + "type": "string", + "description": "The English source text that all translations derive from." } } }, - "IValidationTruthMultiCompareTruth": { + "CreateGlobalTextEndpoint_Output": { "required": [ - "correctCombinations", - "_t" + "globalTextId" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "MultiCompareTruth" - ], - "type": "string" - }, - "correctCombinations": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - } + "globalTextId": { + "type": "string", + "description": "The unique identifier of the created global text entry." } } }, - "IValidationTruthNamedEntityTruth": { + "CreateValidationFeedbackEndpoint_Input": { "required": [ - "classifications", - "_t" + "feedback" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NamedEntityTruth" - ], - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NamedEntityTruth_NamedClassification" - } + "feedback": { + "type": "string", + "description": "The feedback text." } } }, - "IValidationTruthPolygonTruth": { + "GetAllGlobalTextsEndpoint_Output": { "required": [ - "_t" + "globalTexts" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "PolygonTruth" + "globalTexts": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetAllGlobalTextsEndpoint_Output_Item" + } + } ], - "type": "string" + "description": "The list of global text entries." } } }, - "IValidationTruthScrubTruth": { + "GetAllGlobalTextsEndpoint_Output_Item": { "required": [ - "validRanges", - "_t" + "id", + "key", + "englishText" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ScrubTruth" - ], + "id": { "type": "string" }, - "validRanges": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScrubTruth_ScrubRange" - } + "key": { + "type": "string" + }, + "englishText": { + "type": "string" } } }, - "IValidationTruthSkipTruth": { + "GetGlobalResponsesEndpoint_Output": { "required": [ - "_t" + "responses" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "SkipTruth" + "responses": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetGlobalResponsesEndpoint_Output_Response" + } + } ], + "description": "The most recent public responses." + } + } + }, + "GetGlobalResponsesEndpoint_Output_Response": { + "required": [ + "id", + "userId", + "country" + ], + "type": "object", + "properties": { + "id": { "type": "string" + }, + "userId": { + "type": "string" + }, + "country": { + "type": "string" + }, + "age": { + "type": "string", + "nullable": true + }, + "occupation": { + "type": "string", + "nullable": true + }, + "gender": { + "type": "string", + "nullable": true } } }, - "IValidationTruthTranscriptionTruth": { + "GetRapidNavigationEndpoint_Card": { "required": [ - "correctWords", - "_t" + "rapidId", + "asset", + "state", + "payload", + "responses", + "totalResponseCount" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "TranscriptionTruth" - ], + "rapidId": { "type": "string" }, - "correctWords": { + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "state": { + "$ref": "#/components/schemas/RapidState" + }, + "payload": { + "$ref": "#/components/schemas/IRapidPayload" + }, + "responses": { "type": "array", "items": { - "$ref": "#/components/schemas/TranscriptionTruth_TranscriptionWord" + "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Card_Response" } }, - "strictGrading": { - "type": "boolean", + "totalResponseCount": { + "type": "integer", + "format": "int64" + }, + "context": { + "type": "string", "nullable": true }, - "requiredPrecision": { - "type": "number", - "format": "double", + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], "nullable": true }, - "requiredCompleteness": { + "decisiveness": { "type": "number", "format": "double", "nullable": true + }, + "aggregation": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IResponseAggregation" + } + ], + "nullable": true } } }, - "LocateBoxTruth_Box": { + "GetRapidNavigationEndpoint_Card_Response": { + "required": [ + "id", + "userId", + "country", + "language", + "age", + "gender", + "occupation", + "demographicInformation", + "result", + "userScore", + "userScores" + ], "type": "object", "properties": { - "xMin": { - "type": "number", - "format": "double", + "id": { + "type": "string" + }, + "userId": { + "type": "string" + }, + "country": { + "type": "string" + }, + "language": { + "type": "string" + }, + "age": { + "type": "string", "nullable": true }, - "yMin": { - "type": "number", - "format": "double", + "gender": { + "type": "string", "nullable": true }, - "xMax": { - "type": "number", - "format": "double", + "occupation": { + "type": "string", "nullable": true }, - "yMax": { + "demographicInformation": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "result": { + "$ref": "#/components/schemas/IRapidResult" + }, + "userScore": { "type": "number", - "format": "double", - "nullable": true + "format": "double" + }, + "userScores": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double" + } } } }, - "NamedEntityTruth_NamedClassification": { + "GetRapidNavigationEndpoint_Item": { "required": [ - "start", - "end", - "classification" + "rapidId", + "asset", + "state" ], "type": "object", "properties": { - "start": { - "type": "integer", - "format": "int32" + "rapidId": { + "type": "string" }, - "end": { - "type": "integer", - "format": "int32" + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "classification": { - "type": "string" + "state": { + "$ref": "#/components/schemas/RapidState" } } }, - "QueryFlaggedRapidsEndpoint_Output": { + "GetRapidNavigationEndpoint_Output": { "required": [ - "id", - "payload", - "referee", - "asset", - "state", - "hasResponses", - "shouldAcceptIncorrect", - "truth", - "explanation", - "randomCorrectProbability", - "key", - "completedAt", - "featureFlags" + "current", + "previous", + "next", + "index", + "total" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." - }, - "referee": { + "current": { "allOf": [ { - "$ref": "#/components/schemas/IRefereeInfo" + "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Card" } ], - "description": "The referee that created the rapid." + "description": "The anchor rapid, carrying the same fields a results-grid card renders." }, - "asset": { + "previous": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "type": "array", + "items": { + "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Item" + } } ], - "description": "The asset associated with the rapid." + "description": "The rapids preceding the anchor in grid order, at most window entries,\n ordered ascending with the neighbour adjacent to the anchor last." }, - "state": { + "next": { "allOf": [ { - "$ref": "#/components/schemas/RapidState" + "type": "array", + "items": { + "$ref": "#/components/schemas/GetRapidNavigationEndpoint_Item" + } } ], - "description": "The state of the rapid." + "description": "The rapids following the anchor in grid order, at most window entries,\n in ascending order." }, - "hasResponses": { - "type": "boolean", - "description": "Whether the rapid has any responses." + "index": { + "type": "integer", + "description": "The 1-based position of the anchor within the filtered slice.", + "format": "int64" }, - "shouldAcceptIncorrect": { - "type": "boolean", - "description": "Whether the rapid should accept incorrect answers." + "total": { + "type": "integer", + "description": "The total number of rapids in the filtered slice.", + "format": "int64" + } + } + }, + "GetResponsesForRapidEndpoint_Output": { + "required": [ + "rapidId", + "asset", + "responses", + "state" + ], + "type": "object", + "properties": { + "rapidId": { + "type": "string", + "description": "The id of the rapid." }, - "truth": { + "asset": { "allOf": [ { - "$ref": "#/components/schemas/IValidationTruth" + "$ref": "#/components/schemas/IAsset" } ], - "description": "The optional validation truth of the rapid." - }, - "explanation": { - "type": "string", - "description": "The optional explanation shown when users answer incorrectly.", - "nullable": true - }, - "randomCorrectProbability": { - "type": "number", - "description": "The probability of a random correct answer.", - "format": "double", - "nullable": true - }, - "key": { - "type": "string", - "description": "An optional key for the rapid.", - "nullable": true - }, - "completedAt": { - "type": "string", - "description": "The timestamp when the rapid was completed.", - "format": "date-time", - "nullable": true + "description": "The asset of the rapid." }, - "featureFlags": { + "responses": { "allOf": [ { "type": "array", "items": { - "$ref": "#/components/schemas/FeatureFlag" + "$ref": "#/components/schemas/GetResponsesForRapidEndpoint_Output_Response" } } ], - "description": "The feature flags enabled for the rapid." - } - } - }, - "QueryFlaggedRapidsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_Output" - } + "description": "The list of responses for the rapid." }, - "totalPages": { - "type": "integer", - "format": "int32" + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/RapidState" + } + ], + "description": "The state of the rapid." } } }, - "QueryValidationFeedbacksEndpoint_Output": { + "GetResponsesForRapidEndpoint_Output_Response": { "required": [ "id", "userId", - "sessionId", - "feedback", - "createdAt" + "country", + "age", + "gender", + "occupation", + "demographicInformation", + "result", + "userScore", + "userScores" ], "type": "object", "properties": { "id": { - "type": "string", - "description": "The unique identifier of the feedback." + "type": "string" }, "userId": { - "type": "string", - "description": "The ID of the user who submitted the feedback." + "type": "string" }, - "sessionId": { - "type": "string", - "description": "The session ID of the user who submitted the feedback." + "country": { + "type": "string" }, - "feedback": { + "age": { "type": "string", - "description": "The feedback text." + "nullable": true }, - "englishFeedback": { + "gender": { "type": "string", - "description": "The English translation of the feedback, or null when unavailable.", "nullable": true }, - "createdAt": { + "occupation": { "type": "string", - "description": "The timestamp when the feedback was created.", - "format": "date-time" - } - } - }, - "QueryValidationFeedbacksEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" + "nullable": true }, - "page": { - "type": "integer", - "format": "int32" + "demographicInformation": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "pageSize": { - "type": "integer", - "format": "int32" + "result": { + "$ref": "#/components/schemas/IRapidResult" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryValidationFeedbacksEndpoint_Output" - } + "userScore": { + "type": "number", + "format": "double" }, - "totalPages": { - "type": "integer", - "format": "int32" + "userScores": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double" + } } } }, - "QueryValidationRapidEligibilityEndpoint_Output": { - "required": [ - "rapidId", - "payload", - "responseCount", - "confidence", - "truth" - ], + "InspectReportEndpoint_Output": { "type": "object", "properties": { - "rapidId": { + "dump": { "type": "string", - "description": "The id of the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." - }, - "responseCount": { - "type": "integer", - "description": "The number of responses that the rapid has received.", - "format": "int32" - }, - "confidence": { - "type": "number", - "description": "The confidence of the rapid's aggregated response.", - "format": "double" - }, - "truth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The derived validation truth for the rapid." + "description": "The captured dump, if any.", + "nullable": true } } }, - "QueryValidationRapidEligibilityEndpoint_PagedResultOfOutput": { + "IRapid": { "required": [ - "total", - "page", - "pageSize", - "items" + "_t" ], "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" + "oneOf": [ + { + "$ref": "#/components/schemas/IRapidAttachCategoryRapid" }, - "page": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidBoundingBoxRapid" }, - "pageSize": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidCompareRapid" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryValidationRapidEligibilityEndpoint_Output" - } + { + "$ref": "#/components/schemas/IRapidFreeTextRapid" }, - "totalPages": { - "type": "integer", - "format": "int32" + { + "$ref": "#/components/schemas/IRapidLineRapid" + }, + { + "$ref": "#/components/schemas/IRapidLocateRapid" + }, + { + "$ref": "#/components/schemas/IRapidNamedEntityRapid" + }, + { + "$ref": "#/components/schemas/IRapidPolygonRapid" + }, + { + "$ref": "#/components/schemas/IRapidScrubRapid" + }, + { + "$ref": "#/components/schemas/IRapidTranscriptionRapid" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AttachCategoryRapidModel": "#/components/schemas/IRapidAttachCategoryRapid", + "BoundingBoxRapidModel": "#/components/schemas/IRapidBoundingBoxRapid", + "CompareRapidModel": "#/components/schemas/IRapidCompareRapid", + "FreeTextRapidModel": "#/components/schemas/IRapidFreeTextRapid", + "LineRapidModel": "#/components/schemas/IRapidLineRapid", + "LocateRapidModel": "#/components/schemas/IRapidLocateRapid", + "NamedEntityRapidModel": "#/components/schemas/IRapidNamedEntityRapid", + "PolygonRapidModel": "#/components/schemas/IRapidPolygonRapid", + "ScrubRapidModel": "#/components/schemas/IRapidScrubRapid", + "TranscriptionRapidModel": "#/components/schemas/IRapidTranscriptionRapid" } } }, - "RapidIssue": { - "enum": [ - "Other", - "CannotSubmit", - "NoAsset", - "Inappropriate", - "NoCorrectOption", - "WrongLanguage", - "DoNotUnderstand", - "DoNotCare", - "NotSeeOptionsOrMediaDidntLoad", - "MyAnswerIsCorrect" - ] - }, - "ReportRapidEndpoint_Input": { + "IRapidAttachCategoryRapid": { "required": [ - "issue" + "categories", + "title", + "asset", + "featureFlags", + "id", + "_t" ], - "type": "object", "properties": { - "issue": { - "allOf": [ + "_t": { + "enum": [ + "AttachCategoryRapidModel" + ], + "type": "string" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttachCategoryRapid_Category" + } + }, + "title": { + "$ref": "#/components/schemas/TranslatedString" + }, + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "context": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/RapidIssue" + "$ref": "#/components/schemas/TranslatedString" } ], - "description": "A streamlined enum representing common issues." - }, - "message": { - "type": "string", - "description": "An optional message typed by the user.", "nullable": true }, - "dump": { - "type": "string", - "description": "A dump that the frontend defines and can read again.", + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], "nullable": true }, - "source": { - "type": "string", - "description": "An optional identifier where the report originated from.", - "nullable": true - } - } - }, - "ScrubTruth_ScrubRange": { - "required": [ - "start", - "end" - ], - "type": "object", - "properties": { - "start": { - "type": "integer", - "format": "int32" + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } }, - "end": { - "type": "integer", - "format": "int32" + "id": { + "type": "string" } } }, - "SkipRapidEndpoint_Input": { + "IRapidBoundingBoxRapid": { "required": [ - "rapidId", - "sessionIndex" + "target", + "asset", + "featureFlags", + "id", + "_t" ], - "type": "object", "properties": { - "rapidId": { - "type": "string", - "description": "The ID of the Rapid that was skipped." + "_t": { + "enum": [ + "BoundingBoxRapidModel" + ], + "type": "string" }, - "sessionIndex": { - "type": "integer", - "description": "The index of the session when the Rapid was skipped.", - "format": "int32" - } - } - }, - "SkipRapidEndpoint_Output": { - "required": [ - "isAccepted", - "userScore" - ], - "type": "object", - "properties": { - "isAccepted": { - "type": "boolean", - "description": "Whether the skip was accepted." + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "validationTruth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The validation truth applied, if any." + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "explanation": { - "allOf": [ + "context": { + "type": "object", + "oneOf": [ { "$ref": "#/components/schemas/TranslatedString" } ], - "description": "An optional translated explanation for the user." - }, - "userScore": { - "type": "number", - "description": "The user's score after the skip.", - "format": "double" + "nullable": true }, - "nextRapid": { - "allOf": [ + "contextAsset": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/IRapid" + "$ref": "#/components/schemas/IAsset" } ], - "description": "The next rapid to solve when the session streams its rapids and continues.\n Null when there is nothing further to solve." - } - } - }, - "TranscriptionRapid_TranscriptionWord": { - "required": [ - "word", - "wordIndex" - ], - "type": "object", - "properties": { - "word": { - "type": "string" + "nullable": true }, - "wordIndex": { - "type": "integer", - "format": "int32" + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + }, + "id": { + "type": "string" } } }, - "TranscriptionTruth_TranscriptionWord": { + "IRapidCompareRapid": { "required": [ - "word", - "wordIndex" + "criteria", + "asset", + "featureFlags", + "id", + "_t" ], - "type": "object", "properties": { - "word": { + "_t": { + "enum": [ + "CompareRapidModel" + ], "type": "string" }, - "wordIndex": { - "type": "integer", - "format": "int32" + "criteria": { + "$ref": "#/components/schemas/TranslatedString" + }, + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true + }, + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + }, + "id": { + "type": "string" } } }, - "TranslatedString": { + "IRapidFreeTextRapid": { "required": [ - "englishText", - "text", - "targetLanguage" + "question", + "asset", + "featureFlags", + "id", + "_t" ], - "type": "object", "properties": { - "wasTranslated": { - "type": "boolean" - }, - "englishText": { + "_t": { + "enum": [ + "FreeTextRapidModel" + ], "type": "string" }, - "text": { - "type": "string" + "question": { + "$ref": "#/components/schemas/TranslatedString" }, - "targetLanguage": { - "type": "string" - } - } - }, - "UpdateGlobalTextEndpoint_Input": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The new key for the global text entry." + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "englishText": { - "type": "string", - "description": "The new English source text for the global text entry." - } - } - }, - "UpdateValidationRapidEndpoint_Input": { - "type": "object", - "properties": { - "truth": { - "allOf": [ + "context": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/IValidationTruth" + "$ref": "#/components/schemas/TranslatedString" } ], - "description": "The truth for the validation rapid." - }, - "explanation": { - "type": "string", - "description": "The optional explanation shown when users answer incorrectly.", - "nullable": true - }, - "context": { - "type": "string", - "description": "An optional text context to show the user.", "nullable": true }, "contextAsset": { "type": "object", "oneOf": [ { - "$ref": "#/components/schemas/IAssetInput" + "$ref": "#/components/schemas/IAsset" } ], - "description": "An optional asset to use as context to show the user.", "nullable": true }, - "randomCorrectProbability": { - "type": "number", - "description": "The probability that a random answer is correct.", - "format": "double", - "nullable": true + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } }, - "sortIndex": { - "type": "integer", - "description": "Controls the serving order of rapids within a target group.", - "format": "int32" + "id": { + "type": "string" } } }, - "CreateSignalEndpoint_Input": { + "IRapidLineRapid": { "required": [ - "name", - "audienceId", - "jobDefinitionId", - "intervalSeconds" + "target", + "asset", + "featureFlags", + "id", + "_t" ], - "type": "object", "properties": { - "name": { - "type": "string", - "description": "The human-readable name of the signal." + "_t": { + "enum": [ + "LineRapidModel" + ], + "type": "string" }, - "description": { - "type": "string", - "description": "Optional description.", - "nullable": true + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "audienceId": { - "type": "string", - "description": "The audience the spawned jobs will target." + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "jobDefinitionId": { - "type": "string", - "description": "The job definition each firing creates a job from." + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "nullable": true }, - "revisionNumber": { - "type": "integer", - "description": "Optional revision pin; omit for \"latest at fire time\".", - "format": "int32", + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], "nullable": true }, - "intervalSeconds": { - "type": "integer", - "description": "Seconds between consecutive firings. Minimum 60.", - "format": "int32" + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } }, - "isPublic": { - "type": "boolean", - "description": "If true the signal is readable by every authenticated user." + "id": { + "type": "string" } } }, - "CreateSignalEndpoint_Output": { + "IRapidLocateRapid": { "required": [ + "target", + "asset", + "featureFlags", "id", - "nextRunAt" + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the created signal." + "_t": { + "enum": [ + "LocateRapidModel" + ], + "type": "string" }, - "nextRunAt": { - "type": "string", - "description": "Timestamp at which the first scheduled run will fire.", - "format": "date-time" + "target": { + "$ref": "#/components/schemas/TranslatedString" + }, + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true + }, + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } + }, + "id": { + "type": "string" } } }, - "GetSignalByIdEndpoint_Output": { + "IRapidNamedEntityRapid": { "required": [ + "target", + "classes", + "asset", + "featureFlags", "id", - "name", - "audienceId", - "jobDefinitionId", - "intervalSeconds", - "nextRunAt", - "isPaused", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the signal." - }, - "name": { - "type": "string", - "description": "The human-readable name of the signal." + "_t": { + "enum": [ + "NamedEntityRapidModel" + ], + "type": "string" }, - "description": { - "type": "string", - "description": "Optional description.", - "nullable": true + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "audienceId": { - "type": "string", - "description": "The id of the audience the signal targets." + "classes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslatedString" + } }, - "jobDefinitionId": { - "type": "string", - "description": "The id of the job definition each firing creates a job from." + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "revisionNumber": { - "type": "integer", - "description": "Pinned revision number; null means \"latest at fire time\".", - "format": "int32", + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], "nullable": true }, - "intervalSeconds": { - "type": "integer", - "description": "Seconds between consecutive firings.", - "format": "int32" + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true }, - "nextRunAt": { - "type": "string", - "description": "Timestamp of the next scheduled run.", - "format": "date-time" + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } }, - "lastRunAt": { - "type": "string", - "description": "Timestamp of the most recent run (null if the signal has never fired).", - "format": "date-time", - "nullable": true + "id": { + "type": "string" + } + } + }, + "IRapidPolygonRapid": { + "required": [ + "target", + "asset", + "featureFlags", + "id", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "PolygonRapidModel" + ], + "type": "string" }, - "isPaused": { - "type": "boolean", - "description": "Whether the scheduler is currently skipping this signal." + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "isPublic": { - "type": "boolean", - "description": "Whether the signal is readable by every authenticated user." + "asset": { + "$ref": "#/components/schemas/IAsset" }, - "ownerId": { - "type": "string", - "description": "The customer id of the signal owner.", - "format": "uuid" + "context": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "nullable": true }, - "ownerMail": { - "type": "string", - "description": "The email of the signal owner." + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "nullable": true }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } }, - "createdAt": { - "type": "string", - "description": "When the signal was created.", - "format": "date-time" + "id": { + "type": "string" } } }, - "GetSignalRunByIdEndpoint_Output": { + "IRapidScrubRapid": { "required": [ + "target", "id", - "signalId", - "triggerSource", - "status", - "startedAt" + "featureFlags", + "asset", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the run." + "_t": { + "enum": [ + "ScrubRapidModel" + ], + "type": "string" }, - "signalId": { - "type": "string", - "description": "The id of the parent signal." + "target": { + "$ref": "#/components/schemas/TranslatedString" }, - "triggerSource": { - "allOf": [ + "id": { + "type": "string" + }, + "context": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/SignalRunTriggerSource" + "$ref": "#/components/schemas/TranslatedString" } ], - "description": "Whether the run was started by the scheduler or by a manual trigger." + "nullable": true }, - "status": { - "allOf": [ + "contextAsset": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/SignalRunStatus" + "$ref": "#/components/schemas/IAsset" } ], - "description": "Current lifecycle state of the run." - }, - "startedAt": { - "type": "string", - "description": "When the run was started.", - "format": "date-time" - }, - "audienceJobId": { - "type": "string", - "description": "The id of the audience job this run spawned (null until orders confirms creation).", - "nullable": true - }, - "completedAt": { - "type": "string", - "description": "When the run reached a terminal state.", - "format": "date-time", - "nullable": true - }, - "resultFileName": { - "type": "string", - "description": "File name of the audience-job result, when completed.", "nullable": true }, - "failureMessage": { - "type": "string", - "description": "Reason the run failed.", - "nullable": true + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } }, - "skippedReason": { - "type": "string", - "description": "Reason the run was skipped without spawning an audience job.", - "nullable": true + "asset": { + "$ref": "#/components/schemas/IAsset" } } }, - "QuerySignalRunsEndpoint_Output": { + "IRapidTranscriptionRapid": { "required": [ + "transcription", + "title", + "asset", + "featureFlags", "id", - "signalId", - "triggerSource", - "status", - "startedAt" + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the run." + "_t": { + "enum": [ + "TranscriptionRapidModel" + ], + "type": "string" }, - "signalId": { - "type": "string", - "description": "The id of the parent signal." + "transcription": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranscriptionRapid_TranscriptionWord" + } }, - "triggerSource": { - "allOf": [ + "title": { + "$ref": "#/components/schemas/TranslatedString" + }, + "asset": { + "$ref": "#/components/schemas/IAsset" + }, + "context": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/SignalRunTriggerSource" + "$ref": "#/components/schemas/TranslatedString" } ], - "description": "Whether the run was started by the scheduler or by a manual trigger." + "nullable": true }, - "status": { - "allOf": [ + "contextAsset": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/SignalRunStatus" + "$ref": "#/components/schemas/IAsset" } ], - "description": "Current lifecycle state of the run." + "nullable": true }, - "startedAt": { - "type": "string", - "description": "When the run was started.", - "format": "date-time" + "featureFlags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } }, - "audienceJobId": { - "type": "string", - "description": "The id of the audience job this run spawned (null until orders confirms creation).", - "nullable": true + "id": { + "type": "string" + } + } + }, + "IRefereeInfo": { + "required": [ + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IRefereeInfoNaiveRefereeInfo" }, - "completedAt": { - "type": "string", - "description": "When the run reached a terminal state.", - "format": "date-time", - "nullable": true + { + "$ref": "#/components/schemas/IRefereeInfoNeverEndingRefereeInfo" }, - "resultFileName": { - "type": "string", - "description": "File name of the audience-job result, when completed.", - "nullable": true + { + "$ref": "#/components/schemas/IRefereeInfoProbabilisticAttachCategoryRefereeInfo" }, - "failureMessage": { - "type": "string", - "description": "Reason the run failed.", - "nullable": true + { + "$ref": "#/components/schemas/IRefereeInfoQuorumRefereeInfo" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "NaiveRefereeInfo": "#/components/schemas/IRefereeInfoNaiveRefereeInfo", + "NeverEndingRefereeInfo": "#/components/schemas/IRefereeInfoNeverEndingRefereeInfo", + "ProbabilisticAttachCategoryRefereeInfo": "#/components/schemas/IRefereeInfoProbabilisticAttachCategoryRefereeInfo", + "QuorumRefereeInfo": "#/components/schemas/IRefereeInfoQuorumRefereeInfo" + } + } + }, + "IRefereeInfoNaiveRefereeInfo": { + "required": [ + "_t" + ], + "properties": { + "_t": { + "enum": [ + "NaiveRefereeInfo" + ], + "type": "string" }, - "skippedReason": { - "type": "string", - "description": "Reason the run was skipped without spawning an audience job.", + "responseAmountThreshold": { + "type": "integer", + "format": "int32" + }, + "serveThreshold": { + "type": "integer", + "format": "int32", "nullable": true + }, + "guessAmountThreshold": { + "type": "integer", + "format": "int32", + "deprecated": true } } }, - "QuerySignalRunsEndpoint_PagedResultOfOutput": { + "IRefereeInfoNeverEndingRefereeInfo": { "required": [ - "total", - "page", - "pageSize", - "items" + "_t" ], - "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" + "_t": { + "enum": [ + "NeverEndingRefereeInfo" + ], + "type": "string" + } + } + }, + "IRefereeInfoProbabilisticAttachCategoryRefereeInfo": { + "required": [ + "threshold", + "maxVotes", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "ProbabilisticAttachCategoryRefereeInfo" + ], + "type": "string" }, - "page": { + "threshold": { + "type": "number", + "format": "double" + }, + "maxVotes": { "type": "integer", "format": "int32" + } + } + }, + "IRefereeInfoQuorumRefereeInfo": { + "required": [ + "maxVotes", + "threshold", + "_t" + ], + "properties": { + "_t": { + "enum": [ + "QuorumRefereeInfo" + ], + "type": "string" }, - "pageSize": { + "maxVotes": { "type": "integer", "format": "int32" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuerySignalRunsEndpoint_Output" - } - }, - "totalPages": { + "threshold": { "type": "integer", "format": "int32" } } }, - "QuerySignalsEndpoint_Output": { + "IsRapidBagValidEndpoint_Output": { "required": [ - "id", - "name", - "audienceId", - "jobDefinitionId", - "intervalSeconds", - "nextRunAt", - "isPaused", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" + "isValid" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the signal." - }, - "name": { - "type": "string", - "description": "The human-readable name of the signal." - }, - "description": { - "type": "string", - "description": "Optional description.", - "nullable": true + "isValid": { + "type": "boolean", + "description": "Whether the rapid bag is valid." + } + } + }, + "IValidationTruth": { + "required": [ + "_t" + ], + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IValidationTruthAttachCategoryTruth" }, - "audienceId": { - "type": "string", - "description": "The id of the audience the signal targets." + { + "$ref": "#/components/schemas/IValidationTruthBoundingBoxTruth" }, - "jobDefinitionId": { - "type": "string", - "description": "The id of the job definition each firing creates a job from." + { + "$ref": "#/components/schemas/IValidationTruthClassifyTruth" }, - "revisionNumber": { - "type": "integer", - "description": "Pinned revision number; null means \"latest at fire time\".", - "format": "int32", - "nullable": true + { + "$ref": "#/components/schemas/IValidationTruthCompareTruth" }, - "intervalSeconds": { - "type": "integer", - "description": "Seconds between consecutive firings.", - "format": "int32" + { + "$ref": "#/components/schemas/IValidationTruthEmptyValidationTruth" }, - "nextRunAt": { - "type": "string", - "description": "Timestamp of the next scheduled run.", - "format": "date-time" + { + "$ref": "#/components/schemas/IValidationTruthLineTruth" }, - "lastRunAt": { - "type": "string", - "description": "Timestamp of the most recent run (null if the signal has never fired).", - "format": "date-time", - "nullable": true + { + "$ref": "#/components/schemas/IValidationTruthLocateBoxTruth" }, - "isPaused": { - "type": "boolean", - "description": "Whether the scheduler is currently skipping this signal." + { + "$ref": "#/components/schemas/IValidationTruthMultiCompareTruth" }, - "isPublic": { - "type": "boolean", - "description": "Whether the signal is readable by every authenticated user." + { + "$ref": "#/components/schemas/IValidationTruthNamedEntityTruth" }, - "ownerId": { - "type": "string", - "description": "The customer id of the signal owner.", - "format": "uuid" + { + "$ref": "#/components/schemas/IValidationTruthPolygonTruth" }, - "ownerMail": { - "type": "string", - "description": "The email of the signal owner." + { + "$ref": "#/components/schemas/IValidationTruthScrubTruth" }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." + { + "$ref": "#/components/schemas/IValidationTruthSkipTruth" }, - "createdAt": { - "type": "string", - "description": "When the signal was created.", - "format": "date-time" + { + "$ref": "#/components/schemas/IValidationTruthTranscriptionTruth" + } + ], + "discriminator": { + "propertyName": "_t", + "mapping": { + "AttachCategoryTruth": "#/components/schemas/IValidationTruthAttachCategoryTruth", + "BoundingBoxTruth": "#/components/schemas/IValidationTruthBoundingBoxTruth", + "ClassifyTruth": "#/components/schemas/IValidationTruthClassifyTruth", + "CompareTruth": "#/components/schemas/IValidationTruthCompareTruth", + "EmptyValidationTruth": "#/components/schemas/IValidationTruthEmptyValidationTruth", + "LineTruth": "#/components/schemas/IValidationTruthLineTruth", + "LocateBoxTruth": "#/components/schemas/IValidationTruthLocateBoxTruth", + "MultiCompareTruth": "#/components/schemas/IValidationTruthMultiCompareTruth", + "NamedEntityTruth": "#/components/schemas/IValidationTruthNamedEntityTruth", + "PolygonTruth": "#/components/schemas/IValidationTruthPolygonTruth", + "ScrubTruth": "#/components/schemas/IValidationTruthScrubTruth", + "SkipTruth": "#/components/schemas/IValidationTruthSkipTruth", + "TranscriptionTruth": "#/components/schemas/IValidationTruthTranscriptionTruth" } } }, - "QuerySignalsEndpoint_PagedResultOfOutput": { + "IValidationTruthAttachCategoryTruth": { "required": [ - "total", - "page", - "pageSize", - "items" + "correctCategories", + "_t" ], - "type": "object", "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" + "_t": { + "enum": [ + "AttachCategoryTruth" + ], + "type": "string" }, - "items": { + "correctCategories": { "type": "array", "items": { - "$ref": "#/components/schemas/QuerySignalsEndpoint_Output" + "type": "string" } - }, - "totalPages": { - "type": "integer", - "format": "int32" } } }, - "SignalRunStatus": { - "enum": [ - "Pending", - "Running", - "Completed", - "Failed", - "Skipped" - ] - }, - "SignalRunTriggerSource": { - "enum": [ - "Scheduled", - "Manual" - ] - }, - "TriggerSignalEndpoint_Output": { + "IValidationTruthBoundingBoxTruth": { "required": [ - "signalId" + "xMin", + "yMin", + "xMax", + "yMax", + "_t" ], - "type": "object", - "properties": { - "signalId": { - "type": "string", - "description": "Echoes the signal id; the spawned run is created asynchronously." - } - } - }, - "UpdateSignalEndpoint_Input": { - "type": "object", "properties": { - "name": { - "type": "string", - "description": "The new name of the signal." + "_t": { + "enum": [ + "BoundingBoxTruth" + ], + "type": "string" }, - "description": { - "type": "string", - "description": "The new description; pass null to clear it.", - "nullable": true + "xMin": { + "type": "number", + "format": "double" + }, + "yMin": { + "type": "number", + "format": "double" }, - "intervalSeconds": { - "type": "integer", - "description": "The new cadence in seconds. Minimum 60.", - "format": "int32" + "xMax": { + "type": "number", + "format": "double" + }, + "yMax": { + "type": "number", + "format": "double" } } }, - "EnsureEnglishEndpoint_Input": { + "IValidationTruthClassifyTruth": { "required": [ - "text" + "correctCategories", + "_t" ], - "type": "object", "properties": { - "text": { - "type": "string", - "description": "The text to ensure is English." + "_t": { + "enum": [ + "ClassifyTruth" + ], + "type": "string" + }, + "correctCategories": { + "type": "array", + "items": { + "type": "string" + } } } }, - "EnsureEnglishEndpoint_Output": { + "IValidationTruthCompareTruth": { "required": [ - "englishText" + "winnerId", + "_t" ], - "type": "object", "properties": { - "englishText": { - "type": "string", - "description": "The English version of the provided text." + "_t": { + "enum": [ + "CompareTruth" + ], + "type": "string" + }, + "winnerId": { + "type": "string" } } }, - "TranslateEndpoint_Input": { + "IValidationTruthEmptyValidationTruth": { "required": [ - "translator", - "text", - "targetLanguage" + "_t" ], - "type": "object", "properties": { - "translator": { - "allOf": [ - { - "$ref": "#/components/schemas/TranslatorType" - } + "_t": { + "enum": [ + "EmptyValidationTruth" ], - "description": "The type of translator to use." - }, - "text": { - "type": "string", - "description": "The text to translate." - }, - "targetLanguage": { - "type": "string", - "description": "The language to translate the text into." - }, - "sourceLanguage": { - "type": "string", - "description": "The original language of the text." + "type": "string" } } }, - "TranslateEndpoint_Output": { + "IValidationTruthLineTruth": { "required": [ - "translation", - "sourceLanguage", - "targetLanguage" + "_t" ], - "type": "object", "properties": { - "translation": { - "type": "string", - "description": "The translated text." - }, - "sourceLanguage": { - "type": "string", - "description": "The detected or provided source language of the text.", - "nullable": true - }, - "targetLanguage": { - "type": "string", - "description": "The language the text was translated into." + "_t": { + "enum": [ + "LineTruth" + ], + "type": "string" } } }, - "TranslatorType": { - "enum": [ - "Google", - "Deepl", - "OpenAi", - "OpenAi4O", - "OpenAi4OMini", - "LibreTranslate", - "Gemini", - "Tllm" - ] - }, - "AddValidationRapidEndpoint_Input": { + "IValidationTruthLocateBoxTruth": { "required": [ - "asset", - "payload" + "boundingBoxes", + "_t" ], - "type": "object", "properties": { - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "The asset to use for the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } + "_t": { + "enum": [ + "LocateBoxTruth" ], - "description": "The payload to use for the rapid." + "type": "string" }, - "truth": { - "allOf": [ - { - "$ref": "#/components/schemas/IValidationTruth" - } - ], - "description": "The ground truth for the rapid." + "boundingBoxes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LocateBoxTruth_Box" + } }, - "randomCorrectProbability": { + "requiredPrecision": { "type": "number", - "description": "The probability for an answer to be correct when randomly guessing.", - "format": "double", - "nullable": true - }, - "explanation": { - "type": "string", - "description": "An explanation shown to the users if they answer the rapid incorrectly.", - "nullable": true - }, - "context": { - "type": "string", - "description": "An optional textual context that provides additional information to the user about the rapid.", - "nullable": true - }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAssetInput" - } - ], - "description": "An optional asset that provides additional context to the user about the rapid." + "format": "double" }, - "featureFlags": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeatureFlag" - }, - "nullable": true - } - ], - "description": "The feature flags to enable for the rapid." + "requiredCompleteness": { + "type": "number", + "format": "double" } } }, - "AssetType": { - "type": "array", - "items": { - "enum": [ - "None", - "Image", - "Video", - "Audio", - "Text" - ], - "type": "string" - } - }, - "CreateValidationSetEndpoint_Input": { + "IValidationTruthMultiCompareTruth": { "required": [ - "name" + "correctCombinations", + "_t" ], - "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the validation set." + "_t": { + "enum": [ + "MultiCompareTruth" + ], + "type": "string" + }, + "correctCombinations": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } } } }, - "CreateValidationSetEndpoint_Output": { + "IValidationTruthNamedEntityTruth": { "required": [ - "validationSetId" + "classifications", + "_t" ], - "type": "object", "properties": { - "validationSetId": { - "type": "string", - "description": "The id of the created validation set." + "_t": { + "enum": [ + "NamedEntityTruth" + ], + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NamedEntityTruth_NamedClassification" + } } } }, - "GetAvailableValidationSetsEndpoint_Output": { + "IValidationTruthPolygonTruth": { "required": [ - "validationSets" + "_t" ], - "type": "object", "properties": { - "validationSets": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutput" - } - } + "_t": { + "enum": [ + "PolygonTruth" ], - "description": "The validation sets available to the current user's organization." + "type": "string" } } }, - "GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutput": { + "IValidationTruthScrubTruth": { "required": [ - "id", - "name", - "ownerId" + "validRanges", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { + "_t": { + "enum": [ + "ScrubTruth" + ], "type": "string" }, - "ownerId": { - "type": "string", - "format": "uuid" + "validRanges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScrubTruth_ScrubRange" + } } } }, - "GetCompatibleValidationSetsEndpoint_Output": { + "IValidationTruthSkipTruth": { "required": [ - "validationSets" + "_t" ], - "type": "object", "properties": { - "validationSets": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetCompatibleValidationSetsEndpoint_ValidationSetOutput" - } - } + "_t": { + "enum": [ + "SkipTruth" ], - "description": "The validation sets that the rapid can be added to." + "type": "string" } } }, - "GetCompatibleValidationSetsEndpoint_ValidationSetOutput": { + "IValidationTruthTranscriptionTruth": { "required": [ - "id", - "name", - "assetType", - "modality", - "promptType", - "dimensions", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" + "correctWords", + "_t" ], - "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { + "_t": { + "enum": [ + "TranscriptionTruth" + ], "type": "string" }, - "assetType": { - "$ref": "#/components/schemas/AssetType" - }, - "modality": { - "$ref": "#/components/schemas/RapidModality" - }, - "promptType": { - "$ref": "#/components/schemas/PromptType" - }, - "dimensions": { + "correctWords": { "type": "array", "items": { - "type": "string" - }, - "nullable": true - }, - "isPublic": { - "type": "boolean" - }, - "ownerId": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/TranscriptionTruth_TranscriptionWord" + } }, - "ownerMail": { - "type": "string" + "strictGrading": { + "type": "boolean", + "nullable": true }, - "organizationId": { - "type": "string" + "requiredPrecision": { + "type": "number", + "format": "double", + "nullable": true }, - "createdAt": { - "type": "string", - "format": "date-time" + "requiredCompleteness": { + "type": "number", + "format": "double", + "nullable": true } } }, - "GetRecommendedValidationSetEndpoint_Output": { - "required": [ - "validationSets" - ], + "LocateBoxTruth_Box": { "type": "object", "properties": { - "validationSets": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRecommendedValidationSetEndpoint_ValidationSetOutput" - } - } - ], - "description": "The validation sets that best match the provided parameters." + "xMin": { + "type": "number", + "format": "double", + "nullable": true + }, + "yMin": { + "type": "number", + "format": "double", + "nullable": true + }, + "xMax": { + "type": "number", + "format": "double", + "nullable": true + }, + "yMax": { + "type": "number", + "format": "double", + "nullable": true } } }, - "GetRecommendedValidationSetEndpoint_ValidationSetOutput": { + "NamedEntityTruth_NamedClassification": { "required": [ - "id", - "name", - "assetType", - "modality", - "promptType", - "dimensions", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" + "start", + "end", + "classification" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "assetType": { - "$ref": "#/components/schemas/AssetType" - }, - "modality": { - "$ref": "#/components/schemas/RapidModality" - }, - "promptType": { - "$ref": "#/components/schemas/PromptType" - }, - "dimensions": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "isPublic": { - "type": "boolean" - }, - "ownerId": { - "type": "string", - "format": "uuid" + "start": { + "type": "integer", + "format": "int32" }, - "ownerMail": { - "type": "string" + "end": { + "type": "integer", + "format": "int32" }, - "organizationId": { + "classification": { "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time" } } }, - "GetValidationRapidsEndpoint_Output": { + "QueryFlaggedRapidsEndpoint_Output": { "required": [ "id", - "type", - "asset", "payload", - "correctValidationCount", - "invalidValidationCount", - "state" + "referee", + "asset", + "state", + "hasResponses", + "shouldAcceptIncorrect", + "truth", + "explanation", + "randomCorrectProbability", + "key", + "completedAt", + "featureFlags" ], "type": "object", "properties": { @@ -69360,60 +65497,57 @@ "type": "string", "description": "The unique identifier of the rapid." }, - "type": { - "type": "string", - "description": "The type of the rapid." + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapidPayload" + } + ], + "description": "The payload of the rapid." }, - "asset": { + "referee": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/IRefereeInfo" } ], - "description": "The asset associated with the rapid." + "description": "The referee that created the rapid." }, - "truth": { + "asset": { "allOf": [ { - "$ref": "#/components/schemas/IValidationTruth" + "$ref": "#/components/schemas/IAsset" } ], - "description": "The truth of the rapid." + "description": "The asset associated with the rapid." }, - "payload": { + "state": { "allOf": [ { - "$ref": "#/components/schemas/IRapidPayload" + "$ref": "#/components/schemas/RapidState" } ], - "description": "The payload of the rapid." + "description": "The state of the rapid." + }, + "hasResponses": { + "type": "boolean", + "description": "Whether the rapid has any responses." }, - "context": { - "type": "string", - "description": "The optional textual context of the rapid.", - "nullable": true + "shouldAcceptIncorrect": { + "type": "boolean", + "description": "Whether the rapid should accept incorrect answers." }, - "contextAsset": { + "truth": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/IValidationTruth" } ], - "description": "The optional asset shown as context to the user." - }, - "correctValidationCount": { - "type": "integer", - "description": "The number of correct validations received.", - "format": "int32" - }, - "invalidValidationCount": { - "type": "integer", - "description": "The number of invalid validations received.", - "format": "int32" + "description": "The optional validation truth of the rapid." }, "explanation": { "type": "string", - "description": "The explanation shown when users answer incorrectly.", + "description": "The optional explanation shown when users answer incorrectly.", "nullable": true }, "randomCorrectProbability": { @@ -69422,17 +65556,31 @@ "format": "double", "nullable": true }, - "state": { + "key": { + "type": "string", + "description": "An optional key for the rapid.", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "The timestamp when the rapid was completed.", + "format": "date-time", + "nullable": true + }, + "featureFlags": { "allOf": [ { - "$ref": "#/components/schemas/RapidState" + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + } } ], - "description": "The state of the rapid." + "description": "The feature flags enabled for the rapid." } } }, - "GetValidationRapidsEndpoint_PagedResultOfOutput": { + "QueryFlaggedRapidsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -69456,7 +65604,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetValidationRapidsEndpoint_Output" + "$ref": "#/components/schemas/QueryFlaggedRapidsEndpoint_Output" } }, "totalPages": { @@ -69465,158 +65613,120 @@ } } }, - "GetValidationSetByIdEndpoint_Output": { + "QueryValidationFeedbacksEndpoint_Output": { "required": [ "id", - "name", - "isPublic", - "ownerMail", - "organizationId", - "ownerId", - "dimensions", + "userId", + "sessionId", + "feedback", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the validation set." + "description": "The unique identifier of the feedback." }, - "name": { + "userId": { "type": "string", - "description": "The name of the validation set." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the validation set is public." + "description": "The ID of the user who submitted the feedback." }, - "ownerMail": { + "sessionId": { "type": "string", - "description": "The mail of the owning customer." + "description": "The session ID of the user who submitted the feedback." }, - "organizationId": { + "feedback": { "type": "string", - "description": "The id of the organization that owns the entity." + "description": "The feedback text." }, - "ownerId": { + "englishFeedback": { "type": "string", - "description": "The id of the owning customer.", - "format": "uuid" - }, - "dimensions": { - "allOf": [ - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The dimensions shared across all rapids in the validation set." + "description": "The English translation of the feedback, or null when unavailable.", + "nullable": true }, "createdAt": { "type": "string", - "description": "The time at which the validation set was created.", + "description": "The timestamp when the feedback was created.", "format": "date-time" } } }, - "PromptType": { - "type": "array", - "items": { - "enum": [ - "None", - "Text", - "Asset" - ], - "type": "string" + "QueryValidationFeedbacksEndpoint_PagedResultOfOutput": { + "required": [ + "total", + "page", + "pageSize", + "items" + ], + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int64" + }, + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryValidationFeedbacksEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" + } } }, - "QueryValidationSetsEndpoint_Output": { + "QueryValidationRapidEligibilityEndpoint_Output": { "required": [ - "id", - "name", - "assetType", - "modality", - "promptType", - "dimensions", - "isPublic", - "ownerId", - "ownerMail", - "organizationId", - "createdAt" + "rapidId", + "payload", + "responseCount", + "confidence", + "truth" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the validation set." - }, - "name": { + "rapidId": { "type": "string", - "description": "The name of the validation set." + "description": "The id of the rapid." }, - "assetType": { + "payload": { "allOf": [ { - "$ref": "#/components/schemas/AssetType" + "$ref": "#/components/schemas/IRapidPayload" } ], - "description": "The asset types contained in the validation set." + "description": "The payload of the rapid." }, - "modality": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidModality" - } - ], - "description": "The rapid modalities contained in the validation set." + "responseCount": { + "type": "integer", + "description": "The number of responses that the rapid has received.", + "format": "int32" }, - "promptType": { - "allOf": [ - { - "$ref": "#/components/schemas/PromptType" - } - ], - "description": "The prompt types contained in the validation set." + "confidence": { + "type": "number", + "description": "The confidence of the rapid's aggregated response.", + "format": "double" }, - "dimensions": { + "truth": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "$ref": "#/components/schemas/IValidationTruth" } ], - "description": "The dimensions shared across all rapids in the validation set." - }, - "isPublic": { - "type": "boolean", - "description": "Whether the validation set is public." - }, - "ownerId": { - "type": "string", - "description": "The id of the owning customer.", - "format": "uuid" - }, - "ownerMail": { - "type": "string", - "description": "The mail of the owning customer." - }, - "organizationId": { - "type": "string", - "description": "The id of the organization that owns the entity." - }, - "createdAt": { - "type": "string", - "description": "The time at which the validation set was created.", - "format": "date-time" + "description": "The derived validation truth for the rapid." } } }, - "QueryValidationSetsEndpoint_PagedResultOfOutput": { + "QueryValidationRapidEligibilityEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -69640,7 +65750,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryValidationSetsEndpoint_Output" + "$ref": "#/components/schemas/QueryValidationRapidEligibilityEndpoint_Output" } }, "totalPages": { @@ -69649,340 +65759,523 @@ } } }, - "RapidModality": { - "type": "array", - "items": { - "enum": [ - "None", - "BoundingBox", - "Classify", - "Compare", - "FreeText", - "Line", - "Locate", - "NamedEntity", - "Polygon", - "Scrub", - "Transcription" - ], - "type": "string" - } + "RapidIssue": { + "enum": [ + "Other", + "CannotSubmit", + "NoAsset", + "Inappropriate", + "NoCorrectOption", + "WrongLanguage", + "DoNotUnderstand", + "DoNotCare", + "NotSeeOptionsOrMediaDidntLoad", + "MyAnswerIsCorrect" + ] }, - "UpdateValidationSetDimensionsEndpoint_Input": { + "ReportRapidEndpoint_Input": { "required": [ - "dimensions" + "issue" ], "type": "object", "properties": { - "dimensions": { + "issue": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/RapidIssue" } ], - "description": "The dimensions to set on all rapids within the validation set." + "description": "A streamlined enum representing common issues." + }, + "message": { + "type": "string", + "description": "An optional message typed by the user.", + "nullable": true + }, + "dump": { + "type": "string", + "description": "A dump that the frontend defines and can read again.", + "nullable": true + }, + "source": { + "type": "string", + "description": "An optional identifier where the report originated from.", + "nullable": true } } }, - "UpdateValidationSetEndpoint_Input": { + "ScrubTruth_ScrubRange": { + "required": [ + "start", + "end" + ], "type": "object", "properties": { - "name": { + "start": { + "type": "integer", + "format": "int32" + }, + "end": { + "type": "integer", + "format": "int32" + } + } + }, + "SkipRapidEndpoint_Input": { + "required": [ + "rapidId", + "sessionIndex" + ], + "type": "object", + "properties": { + "rapidId": { "type": "string", - "description": "The new name of the validation set." + "description": "The ID of the Rapid that was skipped." }, - "dimensions": { + "sessionIndex": { + "type": "integer", + "description": "The index of the session when the Rapid was skipped.", + "format": "int32" + } + } + }, + "SkipRapidEndpoint_Output": { + "required": [ + "isAccepted", + "userScore" + ], + "type": "object", + "properties": { + "isAccepted": { + "type": "boolean", + "description": "Whether the skip was accepted." + }, + "validationTruth": { "allOf": [ { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/IValidationTruth" } ], - "description": "The new dimensions of the validation set." + "description": "The validation truth applied, if any." }, - "shouldAlert": { - "type": "boolean", - "description": "Whether users should be alerted if they answer incorrectly." + "explanation": { + "allOf": [ + { + "$ref": "#/components/schemas/TranslatedString" + } + ], + "description": "An optional translated explanation for the user." }, - "isPublic": { - "type": "boolean", - "description": "Whether the validation set should be public." + "userScore": { + "type": "number", + "description": "The user's score after the skip.", + "format": "double" }, - "isFlagOverruled": { - "type": "boolean", - "description": "Whether flags on validation rapids should be overruled." + "nextRapid": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapid" + } + ], + "description": "The next rapid to solve when the session streams its rapids and continues.\n Null when there is nothing further to solve." } } }, - "UpdateValidationSetShouldAlertEndpoint_Input": { + "TranscriptionRapid_TranscriptionWord": { "required": [ - "shouldAlert" + "word", + "wordIndex" ], "type": "object", "properties": { - "shouldAlert": { - "type": "boolean", - "description": "A flag indicating whether users should be alerted if they answer incorrectly." + "word": { + "type": "string" + }, + "wordIndex": { + "type": "integer", + "format": "int32" } } }, - "AttachCategoryWorkflowRapidBlueprint_Category": { + "TranscriptionTruth_TranscriptionWord": { "required": [ - "label", - "value" + "word", + "wordIndex" ], "type": "object", "properties": { - "label": { + "word": { "type": "string" }, - "value": { + "wordIndex": { + "type": "integer", + "format": "int32" + } + } + }, + "TranslatedString": { + "required": [ + "englishText", + "text", + "targetLanguage" + ], + "type": "object", + "properties": { + "wasTranslated": { + "type": "boolean" + }, + "englishText": { + "type": "string" + }, + "text": { + "type": "string" + }, + "targetLanguage": { "type": "string" } } }, - "GetCompareAbSummaryEndpoint_Output": { + "UpdateGlobalTextEndpoint_Input": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The new key for the global text entry." + }, + "englishText": { + "type": "string", + "description": "The new English source text for the global text entry." + } + } + }, + "UpdateValidationRapidEndpoint_Input": { + "type": "object", + "properties": { + "truth": { + "allOf": [ + { + "$ref": "#/components/schemas/IValidationTruth" + } + ], + "description": "The truth for the validation rapid." + }, + "explanation": { + "type": "string", + "description": "The optional explanation shown when users answer incorrectly.", + "nullable": true + }, + "context": { + "type": "string", + "description": "An optional text context to show the user.", + "nullable": true + }, + "contextAsset": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } + ], + "description": "An optional asset to use as context to show the user.", + "nullable": true + }, + "randomCorrectProbability": { + "type": "number", + "description": "The probability that a random answer is correct.", + "format": "double", + "nullable": true + }, + "sortIndex": { + "type": "integer", + "description": "Controls the serving order of rapids within a target group.", + "format": "int32" + } + } + }, + "CreateSignalEndpoint_Input": { + "required": [ + "name", + "audienceId", + "jobDefinitionId", + "intervalSeconds" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The human-readable name of the signal." + }, + "description": { + "type": "string", + "description": "Optional description.", + "nullable": true + }, + "audienceId": { + "type": "string", + "description": "The audience the spawned jobs will target." + }, + "jobDefinitionId": { + "type": "string", + "description": "The job definition each firing creates a job from." + }, + "revisionNumber": { + "type": "integer", + "description": "Optional revision pin; omit for \"latest at fire time\".", + "format": "int32", + "nullable": true + }, + "intervalSeconds": { + "type": "integer", + "description": "Seconds between consecutive firings. Minimum 60.", + "format": "int32" + }, + "isPublic": { + "type": "boolean", + "description": "If true the signal is readable by every authenticated user." + } + } + }, + "CreateSignalEndpoint_Output": { "required": [ - "winCounter", - "allTargetGroupsCompleted" + "id", + "nextRunAt" ], "type": "object", "properties": { - "winCounter": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - ], - "description": "The number of times each side was the winner, keyed by the side's name and ordered by\n compared side rather than by wins." + "id": { + "type": "string", + "description": "The unique identifier of the created signal." }, - "allTargetGroupsCompleted": { - "type": "boolean", - "description": "Whether all target groups for this workflow are completed." + "nextRunAt": { + "type": "string", + "description": "Timestamp at which the first scheduled run will fire.", + "format": "date-time" } } }, - "GetGroupedRankingWorkflowResultsEndpoint_Output": { + "GetSignalByIdEndpoint_Output": { "required": [ "id", "name", - "state", - "pairMakerInformation" + "audienceId", + "jobDefinitionId", + "intervalSeconds", + "nextRunAt", + "isPaused", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], "type": "object", "properties": { "id": { "type": "string", - "description": "The id of the sub-workflow." + "description": "The unique identifier of the signal." }, "name": { "type": "string", - "description": "The name of the sub-workflow." + "description": "The human-readable name of the signal." }, - "state": { + "description": { "type": "string", - "description": "The state of the sub-workflow." + "description": "Optional description.", + "nullable": true }, - "pairMakerInformation": { - "allOf": [ - { - "$ref": "#/components/schemas/IPairMakerInformation" - } - ], - "description": "Information about the pair-maker used by the sub-workflow." - } - } - }, - "GetGroupedRankingWorkflowResultsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" + "audienceId": { + "type": "string", + "description": "The id of the audience the signal targets." }, - "page": { + "jobDefinitionId": { + "type": "string", + "description": "The id of the job definition each firing creates a job from." + }, + "revisionNumber": { "type": "integer", - "format": "int32" + "description": "Pinned revision number; null means \"latest at fire time\".", + "format": "int32", + "nullable": true }, - "pageSize": { + "intervalSeconds": { "type": "integer", + "description": "Seconds between consecutive firings.", "format": "int32" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetGroupedRankingWorkflowResultsEndpoint_Output" - } + "nextRunAt": { + "type": "string", + "description": "Timestamp of the next scheduled run.", + "format": "date-time" }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "GetRankingWorkflowResultsEndpoint_Datapoint": { - "required": [ - "workflowDatapointId", - "asset", - "elo" - ], - "type": "object", - "properties": { - "workflowDatapointId": { - "type": "string" + "lastRunAt": { + "type": "string", + "description": "Timestamp of the most recent run (null if the signal has never fired).", + "format": "date-time", + "nullable": true }, - "asset": { - "$ref": "#/components/schemas/IAsset" + "isPaused": { + "type": "boolean", + "description": "Whether the scheduler is currently skipping this signal." }, - "elo": { - "type": "integer", - "format": "int32" + "isPublic": { + "type": "boolean", + "description": "Whether the signal is readable by every authenticated user." + }, + "ownerId": { + "type": "string", + "description": "The customer id of the signal owner.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The email of the signal owner." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "When the signal was created.", + "format": "date-time" } } }, - "GetRankingWorkflowResultsEndpoint_Output": { + "GetSignalRunByIdEndpoint_Output": { "required": [ - "total", - "page", - "pageSize", - "totalVotes", - "items" + "id", + "signalId", + "triggerSource", + "status", + "startedAt" ], "type": "object", "properties": { - "total": { - "type": "integer", - "description": "The total number of items in the result.", - "format": "int64" - }, - "page": { - "type": "integer", - "description": "The current page.", - "format": "int32" + "id": { + "type": "string", + "description": "The unique identifier of the run." }, - "pageSize": { - "type": "integer", - "description": "The size of the page.", - "format": "int32" + "signalId": { + "type": "string", + "description": "The id of the parent signal." }, - "totalVotes": { - "type": "integer", - "description": "The total number of votes across all datapoints.", - "format": "int64" + "triggerSource": { + "allOf": [ + { + "$ref": "#/components/schemas/SignalRunTriggerSource" + } + ], + "description": "Whether the run was started by the scheduler or by a manual trigger." }, - "items": { + "status": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRankingWorkflowResultsEndpoint_Datapoint" - } + "$ref": "#/components/schemas/SignalRunStatus" } ], - "description": "The datapoints on the current page." + "description": "Current lifecycle state of the run." + }, + "startedAt": { + "type": "string", + "description": "When the run was started.", + "format": "date-time" + }, + "audienceJobId": { + "type": "string", + "description": "The id of the audience job this run spawned (null until orders confirms creation).", + "nullable": true + }, + "completedAt": { + "type": "string", + "description": "When the run reached a terminal state.", + "format": "date-time", + "nullable": true + }, + "resultFileName": { + "type": "string", + "description": "File name of the audience-job result, when completed.", + "nullable": true + }, + "failureMessage": { + "type": "string", + "description": "Reason the run failed.", + "nullable": true + }, + "skippedReason": { + "type": "string", + "description": "Reason the run was skipped without spawning an audience job.", + "nullable": true } } }, - "GetSimpleWorkflowResultsEndpoint_Output": { + "QuerySignalRunsEndpoint_Output": { "required": [ - "rapidId", - "payload", - "asset", - "responses", - "totalResponseCount", - "state" + "id", + "signalId", + "triggerSource", + "status", + "startedAt" ], "type": "object", "properties": { - "rapidId": { + "id": { "type": "string", - "description": "The id of the rapid." + "description": "The unique identifier of the run." }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." + "signalId": { + "type": "string", + "description": "The id of the parent signal." }, - "asset": { + "triggerSource": { "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/SignalRunTriggerSource" } ], - "description": "The asset of the rapid." + "description": "Whether the run was started by the scheduler or by a manual trigger." }, - "responses": { + "status": { "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_ResponseOutput" - } + "$ref": "#/components/schemas/SignalRunStatus" } ], - "description": "The (possibly capped) list of responses for the rapid." + "description": "Current lifecycle state of the run." }, - "totalResponseCount": { - "type": "integer", - "description": "The true number of matching responses for this rapid, regardless of whether the\n returned Responses list was capped.", - "format": "int64" + "startedAt": { + "type": "string", + "description": "When the run was started.", + "format": "date-time" }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidState" - } - ], - "description": "The state of the rapid." + "audienceJobId": { + "type": "string", + "description": "The id of the audience job this run spawned (null until orders confirms creation).", + "nullable": true }, - "context": { + "completedAt": { "type": "string", - "description": "The optional textual context of the rapid.", + "description": "When the run reached a terminal state.", + "format": "date-time", "nullable": true }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The optional asset shown as context to the user." + "resultFileName": { + "type": "string", + "description": "File name of the audience-job result, when completed.", + "nullable": true }, - "decisiveness": { - "type": "number", - "description": "The decisiveness of the rapid.", - "format": "double", + "failureMessage": { + "type": "string", + "description": "Reason the run failed.", "nullable": true }, - "aggregation": { - "allOf": [ - { - "$ref": "#/components/schemas/IResponseAggregation" - } - ], - "description": "Per-payload-type aggregation over all matching responses (computed before sampling).\n Populated for Compare and Classify rapids; null otherwise." + "skippedReason": { + "type": "string", + "description": "Reason the run was skipped without spawning an audience job.", + "nullable": true } } }, - "GetSimpleWorkflowResultsEndpoint_PagedResultOfOutput": { + "QuerySignalRunsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -70006,7 +66299,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_Output" + "$ref": "#/components/schemas/QuerySignalRunsEndpoint_Output" } }, "totalPages": { @@ -70015,284 +66308,95 @@ } } }, - "GetSimpleWorkflowResultsEndpoint_ResponseOutput": { + "QuerySignalsEndpoint_Output": { "required": [ "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" + "name", + "audienceId", + "jobDefinitionId", + "intervalSeconds", + "nextRunAt", + "isPaused", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], "type": "object", "properties": { "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" - }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { - "type": "string", - "nullable": true - }, - "occupation": { "type": "string", - "nullable": true - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "GetWorkflowByIdEndpoint_Output": { - "required": [ - "workflow" - ], - "type": "object", - "properties": { - "workflow": { - "allOf": [ - { - "$ref": "#/components/schemas/IWorkflow" - } - ], - "description": "The workflow." - } - } - }, - "GetWorkflowProgressEndpoint_Output": { - "required": [ - "completionPercentage", - "total", - "completed", - "state" - ], - "type": "object", - "properties": { - "completionPercentage": { - "type": "number", - "description": "The percentage of workflow datapoints that have been completed.", - "format": "double" - }, - "total": { - "type": "integer", - "description": "The total number of datapoints in the workflow.", - "format": "int64" - }, - "completed": { - "type": "integer", - "description": "The number of datapoints that have been completed.", - "format": "int64" - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/WorkflowState" - } - ], - "description": "The current state of the workflow." - } - } - }, - "GetWorkflowResponsesEndpoint_Output": { - "required": [ - "responses" - ], - "type": "object", - "properties": { - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetWorkflowResponsesEndpoint_Response" - } - } - ], - "description": "The responses for the workflow." - } - } - }, - "GetWorkflowResponsesEndpoint_Response": { - "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" + "description": "The unique identifier of the signal." }, - "age": { + "name": { "type": "string", - "nullable": true + "description": "The human-readable name of the signal." }, - "gender": { + "description": { "type": "string", + "description": "Optional description.", "nullable": true }, - "occupation": { + "audienceId": { "type": "string", - "nullable": true - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" + "description": "The id of the audience the signal targets." }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "GetWorkflowResultsEndpoint_Output": { - "required": [ - "rapidId", - "payload", - "asset", - "responses", - "totalResponseCount", - "state" - ], - "type": "object", - "properties": { - "rapidId": { + "jobDefinitionId": { "type": "string", - "description": "The id of the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." - }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The asset of the rapid." + "description": "The id of the job definition each firing creates a job from." }, - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetWorkflowResultsEndpoint_ResponseOutput" - } - } - ], - "description": "The (possibly capped) list of responses for the rapid." + "revisionNumber": { + "type": "integer", + "description": "Pinned revision number; null means \"latest at fire time\".", + "format": "int32", + "nullable": true }, - "totalResponseCount": { + "intervalSeconds": { "type": "integer", - "description": "The true number of matching responses for this rapid, regardless of whether the\n returned Responses list was capped.", - "format": "int64" + "description": "Seconds between consecutive firings.", + "format": "int32" }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidState" - } - ], - "description": "The state of the rapid." + "nextRunAt": { + "type": "string", + "description": "Timestamp of the next scheduled run.", + "format": "date-time" }, - "context": { + "lastRunAt": { "type": "string", - "description": "The optional textual context of the rapid.", + "description": "Timestamp of the most recent run (null if the signal has never fired).", + "format": "date-time", "nullable": true }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The optional asset shown as context to the user." + "isPaused": { + "type": "boolean", + "description": "Whether the scheduler is currently skipping this signal." }, - "decisiveness": { - "type": "number", - "description": "The decisiveness of the rapid.", - "format": "double", - "nullable": true + "isPublic": { + "type": "boolean", + "description": "Whether the signal is readable by every authenticated user." }, - "aggregation": { - "allOf": [ - { - "$ref": "#/components/schemas/IResponseAggregation" - } - ], - "description": "Per-payload-type aggregation over all matching responses (computed before sampling).\n Populated for Compare and Classify rapids; null otherwise." + "ownerId": { + "type": "string", + "description": "The customer id of the signal owner.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The email of the signal owner." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "When the signal was created.", + "format": "date-time" } } }, - "GetWorkflowResultsEndpoint_PagedResultOfOutput": { + "QuerySignalsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -70316,7 +66420,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/GetWorkflowResultsEndpoint_Output" + "$ref": "#/components/schemas/QuerySignalsEndpoint_Output" } }, "totalPages": { @@ -70325,571 +66429,711 @@ } } }, - "GetWorkflowResultsEndpoint_ResponseOutput": { + "SignalRunStatus": { + "enum": [ + "Pending", + "Running", + "Completed", + "Failed", + "Skipped" + ] + }, + "SignalRunTriggerSource": { + "enum": [ + "Scheduled", + "Manual" + ] + }, + "TriggerSignalEndpoint_Output": { "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" + "signalId" ], "type": "object", "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" - }, - "age": { + "signalId": { "type": "string", - "nullable": true - }, - "gender": { + "description": "Echoes the signal id; the spawned run is created asynchronously." + } + } + }, + "UpdateSignalEndpoint_Input": { + "type": "object", + "properties": { + "name": { "type": "string", - "nullable": true + "description": "The new name of the signal." }, - "occupation": { + "description": { "type": "string", + "description": "The new description; pass null to clear it.", "nullable": true }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } + "intervalSeconds": { + "type": "integer", + "description": "The new cadence in seconds. Minimum 60.", + "format": "int32" } } }, - "IWorkflow": { + "EnsureEnglishEndpoint_Input": { "required": [ - "_t" + "text" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IWorkflowEvaluationWorkflow" - }, - { - "$ref": "#/components/schemas/IWorkflowGroupedRankingWorkflow" - }, - { - "$ref": "#/components/schemas/IWorkflowRankingWorkflow" - }, - { - "$ref": "#/components/schemas/IWorkflowSimpleWorkflow" + "properties": { + "text": { + "type": "string", + "description": "The text to ensure is English." } + } + }, + "EnsureEnglishEndpoint_Output": { + "required": [ + "englishText" ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "EvaluationWorkflow": "#/components/schemas/IWorkflowEvaluationWorkflow", - "GroupedRankingWorkflowModel": "#/components/schemas/IWorkflowGroupedRankingWorkflow", - "RankingWorkflowModel": "#/components/schemas/IWorkflowRankingWorkflow", - "SimpleWorkflowModel": "#/components/schemas/IWorkflowSimpleWorkflow" + "type": "object", + "properties": { + "englishText": { + "type": "string", + "description": "The English version of the provided text." } } }, - "IWorkflowEvaluationWorkflow": { + "TranslateEndpoint_Input": { "required": [ - "id", - "validationSetId", - "state", - "referee", - "name", - "ownerMail", - "organizationId", - "_t" + "translator", + "text", + "targetLanguage" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "EvaluationWorkflow" + "translator": { + "allOf": [ + { + "$ref": "#/components/schemas/TranslatorType" + } ], - "type": "string" - }, - "id": { - "type": "string" - }, - "validationSetId": { - "type": "string" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" + "description": "The type of translator to use." }, - "name": { - "type": "string" + "text": { + "type": "string", + "description": "The text to translate." }, - "ownerMail": { + "targetLanguage": { "type": "string", - "nullable": true + "description": "The language to translate the text into." }, - "organizationId": { - "type": "string" + "sourceLanguage": { + "type": "string", + "description": "The original language of the text." } } }, - "IWorkflowGroupedRankingWorkflow": { + "TranslateEndpoint_Output": { "required": [ - "id", - "referee", - "state", - "criteria", - "name", - "ownerMail", - "organizationId", - "_t" + "translation", + "sourceLanguage", + "targetLanguage" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "GroupedRankingWorkflowModel" - ], - "type": "string" - }, - "id": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "criteria": { - "type": "string" - }, - "name": { - "type": "string" + "translation": { + "type": "string", + "description": "The translated text." }, - "ownerMail": { + "sourceLanguage": { "type": "string", + "description": "The detected or provided source language of the text.", "nullable": true }, - "organizationId": { - "type": "string" - }, - "rankingConfig": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRankingConfig" - } - ], - "nullable": true + "targetLanguage": { + "type": "string", + "description": "The language the text was translated into." } } }, - "IWorkflowRankingWorkflow": { + "TranslatorType": { + "enum": [ + "Google", + "Deepl", + "OpenAi", + "OpenAi4O", + "OpenAi4OMini", + "LibreTranslate", + "Gemini", + "Tllm" + ] + }, + "AddValidationRapidEndpoint_Input": { "required": [ - "id", - "referee", - "pairMakerInformation", - "state", - "criteria", - "name", - "context", - "contextAsset", - "ownerMail", - "organizationId", - "_t" + "asset", + "payload" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "RankingWorkflowModel" + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAssetInput" + } ], - "type": "string" - }, - "id": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "pairMakerInformation": { - "$ref": "#/components/schemas/IPairMakerInformation" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "criteria": { - "type": "string" + "description": "The asset to use for the rapid." }, - "name": { - "type": "string" + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapidPayload" + } + ], + "description": "The payload to use for the rapid." }, - "rankingConfig": { - "type": "object", - "oneOf": [ + "truth": { + "allOf": [ { - "$ref": "#/components/schemas/IRankingConfig" + "$ref": "#/components/schemas/IValidationTruth" } ], + "description": "The ground truth for the rapid." + }, + "randomCorrectProbability": { + "type": "number", + "description": "The probability for an answer to be correct when randomly guessing.", + "format": "double", + "nullable": true + }, + "explanation": { + "type": "string", + "description": "An explanation shown to the users if they answer the rapid incorrectly.", "nullable": true }, "context": { "type": "string", + "description": "An optional textual context that provides additional information to the user about the rapid.", "nullable": true }, "contextAsset": { - "type": "object", - "oneOf": [ + "allOf": [ { - "$ref": "#/components/schemas/IAsset" + "$ref": "#/components/schemas/IAssetInput" } ], - "nullable": true - }, - "ownerMail": { - "type": "string", - "nullable": true + "description": "An optional asset that provides additional context to the user about the rapid." }, - "organizationId": { - "type": "string" + "featureFlags": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeatureFlag" + }, + "nullable": true + } + ], + "description": "The feature flags to enable for the rapid." } } }, - "IWorkflowRapidBlueprint": { + "AssetType": { + "type": "array", + "items": { + "enum": [ + "None", + "Image", + "Video", + "Audio", + "Text" + ], + "type": "string" + } + }, + "CreateValidationSetEndpoint_Input": { "required": [ - "_t" + "name" ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintLineWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint" + "properties": { + "name": { + "type": "string", + "description": "The name of the validation set." } + } + }, + "CreateValidationSetEndpoint_Output": { + "required": [ + "validationSetId" ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassifyBlueprint": "#/components/schemas/IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint", - "BoundingBoxBlueprint": "#/components/schemas/IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint", - "CompareBlueprint": "#/components/schemas/IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint", - "FreeTextBlueprint": "#/components/schemas/IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint", - "LineBlueprint": "#/components/schemas/IWorkflowRapidBlueprintLineWorkflowRapidBlueprint", - "LocateBlueprint": "#/components/schemas/IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint", - "NamedEntityBlueprint": "#/components/schemas/IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint", - "PolygonBlueprint": "#/components/schemas/IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint", - "ScrubBlueprint": "#/components/schemas/IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint", - "TranscriptionBlueprint": "#/components/schemas/IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint" + "type": "object", + "properties": { + "validationSetId": { + "type": "string", + "description": "The id of the created validation set." } } }, - "IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint": { + "GetAvailableValidationSetsEndpoint_Output": { "required": [ - "categories", - "title", - "_t" + "validationSets" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ClassifyBlueprint" + "validationSets": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutput" + } + } ], + "description": "The validation sets available to the current user's organization." + } + } + }, + "GetAvailableValidationSetsEndpoint_ValidationSetOverviewOutput": { + "required": [ + "id", + "name", + "ownerId" + ], + "type": "object", + "properties": { + "id": { "type": "string" }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachCategoryWorkflowRapidBlueprint_Category" - } - }, - "title": { + "name": { "type": "string" + }, + "ownerId": { + "type": "string", + "format": "uuid" } } }, - "IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint": { + "GetCompatibleValidationSetsEndpoint_Output": { "required": [ - "target", - "_t" + "validationSets" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "BoundingBoxBlueprint" + "validationSets": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetCompatibleValidationSetsEndpoint_ValidationSetOutput" + } + } ], - "type": "string" - }, - "target": { - "type": "string" + "description": "The validation sets that the rapid can be added to." } } }, - "IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint": { + "GetCompatibleValidationSetsEndpoint_ValidationSetOutput": { "required": [ - "criteria", - "indexIdentifiers", - "_t" + "id", + "name", + "assetType", + "modality", + "promptType", + "dimensions", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "CompareBlueprint" - ], + "id": { "type": "string" }, - "criteria": { + "name": { "type": "string" }, - "indexIdentifiers": { + "assetType": { + "$ref": "#/components/schemas/AssetType" + }, + "modality": { + "$ref": "#/components/schemas/RapidModality" + }, + "promptType": { + "$ref": "#/components/schemas/PromptType" + }, + "dimensions": { "type": "array", "items": { "type": "string" - } - } - } - }, - "IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint": { - "required": [ - "question", - "shouldValidateResponse", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FreeTextBlueprint" - ], - "type": "string" - }, - "question": { - "type": "string" + }, + "nullable": true }, - "shouldValidateResponse": { + "isPublic": { "type": "boolean" }, - "validationSystemPrompt": { + "ownerId": { "type": "string", - "nullable": true - } - } - }, - "IWorkflowRapidBlueprintLineWorkflowRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LineBlueprint" - ], + "format": "uuid" + }, + "ownerMail": { "type": "string" }, - "target": { + "organizationId": { "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" } } }, - "IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint": { + "GetRecommendedValidationSetEndpoint_Output": { "required": [ - "target", - "_t" + "validationSets" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "LocateBlueprint" + "validationSets": { + "allOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetRecommendedValidationSetEndpoint_ValidationSetOutput" + } + } ], - "type": "string" - }, - "target": { - "type": "string" + "description": "The validation sets that best match the provided parameters." } } }, - "IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint": { + "GetRecommendedValidationSetEndpoint_ValidationSetOutput": { "required": [ - "target", - "classes", - "_t" + "id", + "name", + "assetType", + "modality", + "promptType", + "dimensions", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "NamedEntityBlueprint" - ], + "id": { "type": "string" }, - "target": { + "name": { "type": "string" }, - "classes": { + "assetType": { + "$ref": "#/components/schemas/AssetType" + }, + "modality": { + "$ref": "#/components/schemas/RapidModality" + }, + "promptType": { + "$ref": "#/components/schemas/PromptType" + }, + "dimensions": { "type": "array", "items": { "type": "string" - } - } - } - }, - "IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonBlueprint" - ], + }, + "nullable": true + }, + "isPublic": { + "type": "boolean" + }, + "ownerId": { + "type": "string", + "format": "uuid" + }, + "ownerMail": { "type": "string" }, - "target": { + "organizationId": { "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time" } } }, - "IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint": { + "GetValidationRapidsEndpoint_Output": { "required": [ - "target", - "_t" + "id", + "type", + "asset", + "payload", + "correctValidationCount", + "invalidValidationCount", + "state" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "ScrubBlueprint" + "id": { + "type": "string", + "description": "The unique identifier of the rapid." + }, + "type": { + "type": "string", + "description": "The type of the rapid." + }, + "asset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } ], - "type": "string" + "description": "The asset associated with the rapid." }, - "target": { - "type": "string" + "truth": { + "allOf": [ + { + "$ref": "#/components/schemas/IValidationTruth" + } + ], + "description": "The truth of the rapid." + }, + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/IRapidPayload" + } + ], + "description": "The payload of the rapid." + }, + "context": { + "type": "string", + "description": "The optional textual context of the rapid.", + "nullable": true + }, + "contextAsset": { + "allOf": [ + { + "$ref": "#/components/schemas/IAsset" + } + ], + "description": "The optional asset shown as context to the user." + }, + "correctValidationCount": { + "type": "integer", + "description": "The number of correct validations received.", + "format": "int32" + }, + "invalidValidationCount": { + "type": "integer", + "description": "The number of invalid validations received.", + "format": "int32" + }, + "explanation": { + "type": "string", + "description": "The explanation shown when users answer incorrectly.", + "nullable": true + }, + "randomCorrectProbability": { + "type": "number", + "description": "The probability of a random correct answer.", + "format": "double", + "nullable": true + }, + "state": { + "allOf": [ + { + "$ref": "#/components/schemas/RapidState" + } + ], + "description": "The state of the rapid." } } }, - "IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint": { + "GetValidationRapidsEndpoint_PagedResultOfOutput": { "required": [ - "title", - "_t" + "total", + "page", + "pageSize", + "items" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "TranscriptionBlueprint" - ], - "type": "string" + "total": { + "type": "integer", + "format": "int64" }, - "title": { - "type": "string" + "page": { + "type": "integer", + "format": "int32" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GetValidationRapidsEndpoint_Output" + } + }, + "totalPages": { + "type": "integer", + "format": "int32" } } }, - "IWorkflowSimpleWorkflow": { + "GetValidationSetByIdEndpoint_Output": { "required": [ "id", - "state", - "blueprint", - "referee", "name", + "isPublic", "ownerMail", "organizationId", - "_t" + "ownerId", + "dimensions", + "createdAt" ], + "type": "object", "properties": { - "_t": { - "enum": [ - "SimpleWorkflowModel" - ], - "type": "string" - }, "id": { - "type": "string" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "blueprint": { - "$ref": "#/components/schemas/IWorkflowRapidBlueprint" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" + "type": "string", + "description": "The unique identifier of the validation set." }, "name": { - "type": "string" + "type": "string", + "description": "The name of the validation set." + }, + "isPublic": { + "type": "boolean", + "description": "Whether the validation set is public." }, "ownerMail": { "type": "string", - "nullable": true + "description": "The mail of the owning customer." }, "organizationId": { - "type": "string" + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "ownerId": { + "type": "string", + "description": "The id of the owning customer.", + "format": "uuid" + }, + "dimensions": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The dimensions shared across all rapids in the validation set." + }, + "createdAt": { + "type": "string", + "description": "The time at which the validation set was created.", + "format": "date-time" } } }, - "QueryWorkflowsEndpoint_Output": { + "PromptType": { + "type": "array", + "items": { + "enum": [ + "None", + "Text", + "Asset" + ], + "type": "string" + } + }, + "QueryValidationSetsEndpoint_Output": { "required": [ - "workflow" + "id", + "name", + "assetType", + "modality", + "promptType", + "dimensions", + "isPublic", + "ownerId", + "ownerMail", + "organizationId", + "createdAt" ], "type": "object", "properties": { - "workflow": { + "id": { + "type": "string", + "description": "The unique identifier of the validation set." + }, + "name": { + "type": "string", + "description": "The name of the validation set." + }, + "assetType": { + "allOf": [ + { + "$ref": "#/components/schemas/AssetType" + } + ], + "description": "The asset types contained in the validation set." + }, + "modality": { + "allOf": [ + { + "$ref": "#/components/schemas/RapidModality" + } + ], + "description": "The rapid modalities contained in the validation set." + }, + "promptType": { + "allOf": [ + { + "$ref": "#/components/schemas/PromptType" + } + ], + "description": "The prompt types contained in the validation set." + }, + "dimensions": { "allOf": [ { - "$ref": "#/components/schemas/IWorkflow" + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } ], - "description": "The workflow." + "description": "The dimensions shared across all rapids in the validation set." + }, + "isPublic": { + "type": "boolean", + "description": "Whether the validation set is public." + }, + "ownerId": { + "type": "string", + "description": "The id of the owning customer.", + "format": "uuid" + }, + "ownerMail": { + "type": "string", + "description": "The mail of the owning customer." + }, + "organizationId": { + "type": "string", + "description": "The id of the organization that owns the entity." + }, + "createdAt": { + "type": "string", + "description": "The time at which the validation set was created.", + "format": "date-time" } } }, - "QueryWorkflowsEndpoint_PagedResultOfOutput": { + "QueryValidationSetsEndpoint_PagedResultOfOutput": { "required": [ "total", "page", @@ -70913,7 +67157,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/QueryWorkflowsEndpoint_Output" + "$ref": "#/components/schemas/QueryValidationSetsEndpoint_Output" } }, "totalPages": { @@ -70922,15 +67166,87 @@ } } }, - "WorkflowState": { - "enum": [ - "Created", - "Started", - "Labeling", - "Paused", - "Done", - "Failed" - ] + "RapidModality": { + "type": "array", + "items": { + "enum": [ + "None", + "BoundingBox", + "Classify", + "Compare", + "FreeText", + "Line", + "Locate", + "NamedEntity", + "Polygon", + "Scrub", + "Transcription" + ], + "type": "string" + } + }, + "UpdateValidationSetDimensionsEndpoint_Input": { + "required": [ + "dimensions" + ], + "type": "object", + "properties": { + "dimensions": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The dimensions to set on all rapids within the validation set." + } + } + }, + "UpdateValidationSetEndpoint_Input": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The new name of the validation set." + }, + "dimensions": { + "allOf": [ + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The new dimensions of the validation set." + }, + "shouldAlert": { + "type": "boolean", + "description": "Whether users should be alerted if they answer incorrectly." + }, + "isPublic": { + "type": "boolean", + "description": "Whether the validation set should be public." + }, + "isFlagOverruled": { + "type": "boolean", + "description": "Whether flags on validation rapids should be overruled." + } + } + }, + "UpdateValidationSetShouldAlertEndpoint_Input": { + "required": [ + "shouldAlert" + ], + "type": "object", + "properties": { + "shouldAlert": { + "type": "boolean", + "description": "A flag indicating whether users should be alerted if they answer incorrectly." + } + } } }, "securitySchemes": { @@ -71035,12 +67351,6 @@ "Payment" ] }, - { - "name": "Rapidata Pipeline API", - "tags": [ - "Pipeline" - ] - }, { "name": "Rapidata Rapid API", "tags": [ @@ -71068,16 +67378,6 @@ "tags": [ "ValidationSet" ] - }, - { - "name": "Rapidata Workflow API", - "tags": [ - "Evaluation", - "GroupedRanking", - "Ranking", - "SimpleWorkflow", - "Workflow" - ] } ] } \ No newline at end of file diff --git a/openapi/schemas/signal.openapi.json b/openapi/schemas/signal.openapi.json index 10309f0069..0c0e0d14f8 100644 --- a/openapi/schemas/signal.openapi.json +++ b/openapi/schemas/signal.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Signal API", "description": "The API for the Rapidata Signal service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/translation.openapi.json b/openapi/schemas/translation.openapi.json index 04bd570144..23b9f838de 100644 --- a/openapi/schemas/translation.openapi.json +++ b/openapi/schemas/translation.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Translation API", "description": "The API for the Rapidata Translation service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/validation.openapi.json b/openapi/schemas/validation.openapi.json index 511bf180a9..e0734051c7 100644 --- a/openapi/schemas/validation.openapi.json +++ b/openapi/schemas/validation.openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Rapidata Validation API", "description": "The API for the Rapidata Validation service", - "version": "2026.08.20.1843-f4aff59" + "version": "2026.08.21.0757-4bc4250" }, "servers": [ { diff --git a/openapi/schemas/workflow.openapi.json b/openapi/schemas/workflow.openapi.json deleted file mode 100644 index 15deaa0c19..0000000000 --- a/openapi/schemas/workflow.openapi.json +++ /dev/null @@ -1,3822 +0,0 @@ -{ - "openapi": "3.0.4", - "info": { - "title": "Rapidata Workflow API", - "description": "The API for the Rapidata Workflow service", - "version": "2026.08.20.1843-f4aff59" - }, - "servers": [ - { - "url": "https://api.rabbitdata.ch/" - } - ], - "paths": { - "/workflow/evaluation/{workflowId}/results": { - "get": { - "tags": [ - "Evaluation" - ], - "summary": "Gets the results for an evaluation workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the results for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "states", - "in": "query", - "description": "Optional list of rapid states to filter by. If not provided, all states are included.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RapidState" - } - } - }, - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "id", - "-id" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetWorkflowResultsEndpoint_PagedResultOfOutput" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true - } - }, - "/workflow/grouped-ranking/{workflowId}/results": { - "get": { - "tags": [ - "GroupedRanking" - ], - "summary": "Gets the result overview for a grouped ranking workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the results for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "name", - "-name", - "state", - "-state", - "created_at", - "-created_at" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - }, - { - "name": "id", - "in": "query", - "description": "Filter by id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "name", - "in": "query", - "description": "Filter by name.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "state", - "in": "query", - "description": "Filter by state.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "logic", - "in": "query", - "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", - "schema": { - "enum": [ - "and", - "or" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetGroupedRankingWorkflowResultsEndpoint_PagedResultOfOutput" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true - } - }, - "/workflow/compare/{workflowId}/results": { - "get": { - "tags": [ - "Ranking" - ], - "summary": "Gets the result overview for a ranking workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the results for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "id", - "-id", - "score", - "-score" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetRankingWorkflowResultsEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true - } - }, - "/workflow/simple/{workflowId}/results": { - "get": { - "tags": [ - "SimpleWorkflow" - ], - "summary": "Gets the result overview for a simple workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the results for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "states", - "in": "query", - "description": "Optional list of rapid states to include in the results.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RapidState" - } - } - }, - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "id", - "-id", - "state", - "-state", - "decisiveness", - "-decisiveness", - "accepted_response_count", - "-accepted_response_count", - "has_responses", - "-has_responses" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_PagedResultOfOutput" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true - } - }, - "/workflow/{workflowId}": { - "delete": { - "tags": [ - "Workflow" - ], - "summary": "Deletes a workflow by its id.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to delete.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - } - }, - "get": { - "tags": [ - "Workflow" - ], - "summary": "Returns the workflow identified by workflowId.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "Identifier of the workflow to fetch.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetWorkflowByIdEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true - } - }, - "/workflow/{workflowId}/compare-ab-summary": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Returns the number of times each asset index won across the workflow's rapids.", - "description": "The entries of winCounter are ordered by compared side: the first is the first\n compared side, the second is the second, and so on. That order is the order of the\n workflow's compare blueprint, which is also the order the sides' assets appear in on every\n rapid returned by /workflow/simple/{workflowId}/results — so rendering the entries\n as they arrive lines up with the individual rapids. Sides that have not won a rapid yet\n are present with a count of 0.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the summary for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "useUserScore", - "in": "query", - "description": "Whether to use the user score to determine the winner.", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCompareAbSummaryEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true - } - }, - "/workflow/{workflowId}/progress": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Gets the progress of a workflow.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the progress for.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetWorkflowProgressEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true - } - }, - "/workflow/{workflowId}/responses": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Gets the most recent or oldest responses for a workflow, across any rapid.", - "parameters": [ - { - "name": "workflowId", - "in": "path", - "description": "The ID of the workflow to get the responses for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "The maximum number of responses to return.", - "schema": { - "type": "integer", - "format": "int32", - "default": 100 - } - }, - { - "name": "sort", - "in": "query", - "description": "Whether the oldest or most recent responses should be returned.", - "schema": { - "$ref": "#/components/schemas/SortDirection" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetWorkflowResponsesEndpoint_Output" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - }, - "deprecated": true - } - }, - "/workflows": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Queries workflows based on the provided filter, page, and sort criteria.", - "parameters": [ - { - "name": "page", - "in": "query", - "description": "The 1-based page index.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "page_size", - "in": "query", - "description": "The number of items per page.", - "schema": { - "type": "integer" - }, - "x-parameter-group": "page" - }, - { - "name": "sort", - "in": "query", - "description": "Sort fields. Prefix with - for descending order (e.g. -created_at).", - "schema": { - "type": "array", - "items": { - "enum": [ - "name", - "-name", - "state", - "-state", - "created_at", - "-created_at" - ], - "type": "string" - } - }, - "x-parameter-group": "sort" - }, - { - "name": "id", - "in": "query", - "description": "Filter by id.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "name", - "in": "query", - "description": "Filter by name.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "state", - "in": "query", - "description": "Filter by state.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "owner_mail", - "in": "query", - "description": "Filter by owner_mail.", - "style": "deepObject", - "explode": true, - "schema": { - "type": "object", - "properties": { - "eq": { - "type": "string" - }, - "neq": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "gte": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "starts_with": { - "type": "string" - }, - "ends_with": { - "type": "string" - }, - "in": { - "type": "array", - "items": { - "type": "string" - } - }, - "not_contains": { - "type": "string" - } - } - }, - "x-parameter-group": "filters" - }, - { - "name": "logic", - "in": "query", - "description": "How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.", - "schema": { - "enum": [ - "and", - "or" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QueryWorkflowsEndpoint_PagedResultOfOutput" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthenticated" - }, - "403": { - "description": "Forbidden" - } - } - } - } - }, - "components": { - "schemas": { - "AttachCategoryWorkflowRapidBlueprint_Category": { - "required": [ - "label", - "value" - ], - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "BoundingBoxResult_Box": { - "type": "object", - "properties": { - "xMin": { - "type": "number", - "format": "double", - "nullable": true - }, - "yMin": { - "type": "number", - "format": "double", - "nullable": true - }, - "xMax": { - "type": "number", - "format": "double", - "nullable": true - }, - "yMax": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "ClassifyPayload_Category": { - "required": [ - "label" - ], - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "value": { - "type": "string", - "nullable": true - } - } - }, - "FileType": { - "enum": [ - "Unknown", - "Image", - "Video", - "Audio" - ] - }, - "GetCompareAbSummaryEndpoint_Output": { - "required": [ - "winCounter", - "allTargetGroupsCompleted" - ], - "type": "object", - "properties": { - "winCounter": { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - ], - "description": "The number of times each side was the winner, keyed by the side's name and ordered by\n compared side rather than by wins." - }, - "allTargetGroupsCompleted": { - "type": "boolean", - "description": "Whether all target groups for this workflow are completed." - } - } - }, - "GetGroupedRankingWorkflowResultsEndpoint_Output": { - "required": [ - "id", - "name", - "state", - "pairMakerInformation" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The id of the sub-workflow." - }, - "name": { - "type": "string", - "description": "The name of the sub-workflow." - }, - "state": { - "type": "string", - "description": "The state of the sub-workflow." - }, - "pairMakerInformation": { - "allOf": [ - { - "$ref": "#/components/schemas/IPairMakerInformation" - } - ], - "description": "Information about the pair-maker used by the sub-workflow." - } - } - }, - "GetGroupedRankingWorkflowResultsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetGroupedRankingWorkflowResultsEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "GetRankingWorkflowResultsEndpoint_Datapoint": { - "required": [ - "workflowDatapointId", - "asset", - "elo" - ], - "type": "object", - "properties": { - "workflowDatapointId": { - "type": "string" - }, - "asset": { - "$ref": "#/components/schemas/IAsset" - }, - "elo": { - "type": "integer", - "format": "int32" - } - } - }, - "GetRankingWorkflowResultsEndpoint_Output": { - "required": [ - "total", - "page", - "pageSize", - "totalVotes", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of items in the result.", - "format": "int64" - }, - "page": { - "type": "integer", - "description": "The current page.", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "description": "The size of the page.", - "format": "int32" - }, - "totalVotes": { - "type": "integer", - "description": "The total number of votes across all datapoints.", - "format": "int64" - }, - "items": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetRankingWorkflowResultsEndpoint_Datapoint" - } - } - ], - "description": "The datapoints on the current page." - } - } - }, - "GetSimpleWorkflowResultsEndpoint_Output": { - "required": [ - "rapidId", - "payload", - "asset", - "responses", - "totalResponseCount", - "state" - ], - "type": "object", - "properties": { - "rapidId": { - "type": "string", - "description": "The id of the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." - }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The asset of the rapid." - }, - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_ResponseOutput" - } - } - ], - "description": "The (possibly capped) list of responses for the rapid." - }, - "totalResponseCount": { - "type": "integer", - "description": "The true number of matching responses for this rapid, regardless of whether the\n returned Responses list was capped.", - "format": "int64" - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidState" - } - ], - "description": "The state of the rapid." - }, - "context": { - "type": "string", - "description": "The optional textual context of the rapid.", - "nullable": true - }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The optional asset shown as context to the user." - }, - "decisiveness": { - "type": "number", - "description": "The decisiveness of the rapid.", - "format": "double", - "nullable": true - }, - "aggregation": { - "allOf": [ - { - "$ref": "#/components/schemas/IResponseAggregation" - } - ], - "description": "Per-payload-type aggregation over all matching responses (computed before sampling).\n Populated for Compare and Classify rapids; null otherwise." - } - } - }, - "GetSimpleWorkflowResultsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetSimpleWorkflowResultsEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "GetSimpleWorkflowResultsEndpoint_ResponseOutput": { - "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" - }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { - "type": "string", - "nullable": true - }, - "occupation": { - "type": "string", - "nullable": true - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "GetWorkflowByIdEndpoint_Output": { - "required": [ - "workflow" - ], - "type": "object", - "properties": { - "workflow": { - "allOf": [ - { - "$ref": "#/components/schemas/IWorkflow" - } - ], - "description": "The workflow." - } - } - }, - "GetWorkflowProgressEndpoint_Output": { - "required": [ - "completionPercentage", - "total", - "completed", - "state" - ], - "type": "object", - "properties": { - "completionPercentage": { - "type": "number", - "description": "The percentage of workflow datapoints that have been completed.", - "format": "double" - }, - "total": { - "type": "integer", - "description": "The total number of datapoints in the workflow.", - "format": "int64" - }, - "completed": { - "type": "integer", - "description": "The number of datapoints that have been completed.", - "format": "int64" - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/WorkflowState" - } - ], - "description": "The current state of the workflow." - } - } - }, - "GetWorkflowResponsesEndpoint_Output": { - "required": [ - "responses" - ], - "type": "object", - "properties": { - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetWorkflowResponsesEndpoint_Response" - } - } - ], - "description": "The responses for the workflow." - } - } - }, - "GetWorkflowResponsesEndpoint_Response": { - "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" - }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { - "type": "string", - "nullable": true - }, - "occupation": { - "type": "string", - "nullable": true - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "GetWorkflowResultsEndpoint_Output": { - "required": [ - "rapidId", - "payload", - "asset", - "responses", - "totalResponseCount", - "state" - ], - "type": "object", - "properties": { - "rapidId": { - "type": "string", - "description": "The id of the rapid." - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/IRapidPayload" - } - ], - "description": "The payload of the rapid." - }, - "asset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The asset of the rapid." - }, - "responses": { - "allOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetWorkflowResultsEndpoint_ResponseOutput" - } - } - ], - "description": "The (possibly capped) list of responses for the rapid." - }, - "totalResponseCount": { - "type": "integer", - "description": "The true number of matching responses for this rapid, regardless of whether the\n returned Responses list was capped.", - "format": "int64" - }, - "state": { - "allOf": [ - { - "$ref": "#/components/schemas/RapidState" - } - ], - "description": "The state of the rapid." - }, - "context": { - "type": "string", - "description": "The optional textual context of the rapid.", - "nullable": true - }, - "contextAsset": { - "allOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "description": "The optional asset shown as context to the user." - }, - "decisiveness": { - "type": "number", - "description": "The decisiveness of the rapid.", - "format": "double", - "nullable": true - }, - "aggregation": { - "allOf": [ - { - "$ref": "#/components/schemas/IResponseAggregation" - } - ], - "description": "Per-payload-type aggregation over all matching responses (computed before sampling).\n Populated for Compare and Classify rapids; null otherwise." - } - } - }, - "GetWorkflowResultsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetWorkflowResultsEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "GetWorkflowResultsEndpoint_ResponseOutput": { - "required": [ - "id", - "userId", - "country", - "language", - "age", - "gender", - "occupation", - "demographicInformation", - "result", - "userScore", - "userScores" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "country": { - "type": "string" - }, - "language": { - "type": "string" - }, - "age": { - "type": "string", - "nullable": true - }, - "gender": { - "type": "string", - "nullable": true - }, - "occupation": { - "type": "string", - "nullable": true - }, - "demographicInformation": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "result": { - "$ref": "#/components/schemas/IRapidResult" - }, - "userScore": { - "type": "number", - "format": "double" - }, - "userScores": { - "type": "object", - "additionalProperties": { - "type": "number", - "format": "double" - } - } - } - }, - "IAsset": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAssetFileAsset" - }, - { - "$ref": "#/components/schemas/IAssetMultiAsset" - }, - { - "$ref": "#/components/schemas/IAssetNullAsset" - }, - { - "$ref": "#/components/schemas/IAssetTextAsset" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FileAsset": "#/components/schemas/IAssetFileAsset", - "MultiAsset": "#/components/schemas/IAssetMultiAsset", - "NullAsset": "#/components/schemas/IAssetNullAsset", - "TextAsset": "#/components/schemas/IAssetTextAsset" - } - } - }, - "IAssetFileAsset": { - "required": [ - "fileName", - "metadata", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FileAsset" - ], - "type": "string" - }, - "fileName": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataModelCollection" - }, - "identifier": { - "type": "string" - } - } - }, - "IAssetMultiAsset": { - "required": [ - "assets", - "metadata", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "MultiAsset" - ], - "type": "string" - }, - "assets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IAsset" - } - }, - "metadata": { - "$ref": "#/components/schemas/MetadataModelCollection" - }, - "identifier": { - "type": "string" - } - } - }, - "IAssetNullAsset": { - "required": [ - "metadata", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NullAsset" - ], - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataModelCollection" - }, - "identifier": { - "type": "string" - } - } - }, - "IAssetTextAsset": { - "required": [ - "text", - "metadata", - "identifier", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TextAsset" - ], - "type": "string" - }, - "text": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataModelCollection" - }, - "identifier": { - "type": "string" - } - } - }, - "IMetadata": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IMetadataClassificationMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataCountMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataFileTypeMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataImageDimensionMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataLocationMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataOriginalFilenameMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataSourceUrlMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataStreamsMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataTextMetadata" - }, - { - "$ref": "#/components/schemas/IMetadataVideoDurationMetadata" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassificationMetadata": "#/components/schemas/IMetadataClassificationMetadata", - "CountMetadata": "#/components/schemas/IMetadataCountMetadata", - "FileTypeMetadata": "#/components/schemas/IMetadataFileTypeMetadata", - "ImageDimensionMetadata": "#/components/schemas/IMetadataImageDimensionMetadata", - "LocationMetadata": "#/components/schemas/IMetadataLocationMetadata", - "OriginalFilenameMetadata": "#/components/schemas/IMetadataOriginalFilenameMetadata", - "SourceUrlMetadataModel": "#/components/schemas/IMetadataSourceUrlMetadata", - "StreamsMetadata": "#/components/schemas/IMetadataStreamsMetadata", - "TextMetadata": "#/components/schemas/IMetadataTextMetadata", - "VideoDurationMetadata": "#/components/schemas/IMetadataVideoDurationMetadata" - } - } - }, - "IMetadataClassificationMetadata": { - "required": [ - "classification", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassificationMetadata" - ], - "type": "string" - }, - "classification": { - "type": "string" - } - } - }, - "IMetadataCountMetadata": { - "required": [ - "count", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CountMetadata" - ], - "type": "string" - }, - "count": { - "type": "integer", - "format": "int32" - } - } - }, - "IMetadataFileTypeMetadata": { - "required": [ - "fileType", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FileTypeMetadata" - ], - "type": "string" - }, - "fileType": { - "$ref": "#/components/schemas/FileType" - } - } - }, - "IMetadataImageDimensionMetadata": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ImageDimensionMetadata" - ], - "type": "string" - }, - "height": { - "type": "integer", - "format": "int32" - }, - "width": { - "type": "integer", - "format": "int32" - } - } - }, - "IMetadataLocationMetadata": { - "required": [ - "x", - "y", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocationMetadata" - ], - "type": "string" - }, - "x": { - "type": "number", - "format": "float" - }, - "y": { - "type": "number", - "format": "float" - } - } - }, - "IMetadataOriginalFilenameMetadata": { - "required": [ - "originalFilename", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "OriginalFilenameMetadata" - ], - "type": "string" - }, - "originalFilename": { - "type": "string" - } - } - }, - "IMetadataSourceUrlMetadata": { - "required": [ - "url", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "SourceUrlMetadataModel" - ], - "type": "string" - }, - "url": { - "type": "string" - } - } - }, - "IMetadataStreamsMetadata": { - "required": [ - "hasVideo", - "hasAudio", - "hasSubtitles", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "StreamsMetadata" - ], - "type": "string" - }, - "hasVideo": { - "type": "boolean" - }, - "hasAudio": { - "type": "boolean" - }, - "hasSubtitles": { - "type": "boolean" - } - } - }, - "IMetadataTextMetadata": { - "required": [ - "text", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TextMetadata" - ], - "type": "string" - }, - "text": { - "type": "string", - "nullable": true - } - } - }, - "IMetadataVideoDurationMetadata": { - "required": [ - "duration", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "VideoDurationMetadata" - ], - "type": "string" - }, - "duration": { - "type": "string", - "format": "date-time" - } - } - }, - "IPairMakerInformation": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IPairMakerInformationFullPermutationPairMakerInformation" - }, - { - "$ref": "#/components/schemas/IPairMakerInformationOnlinePairMakerInformation" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "FullPermutationPairMakerInformation": "#/components/schemas/IPairMakerInformationFullPermutationPairMakerInformation", - "OnlinePairMakerInformation": "#/components/schemas/IPairMakerInformationOnlinePairMakerInformation" - } - } - }, - "IPairMakerInformationFullPermutationPairMakerInformation": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FullPermutationPairMakerInformation" - ], - "type": "string" - } - } - }, - "IPairMakerInformationOnlinePairMakerInformation": { - "required": [ - "randomMatchesRatio", - "totalComparisonBudget", - "currentComparisonBudget", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "OnlinePairMakerInformation" - ], - "type": "string" - }, - "randomMatchesRatio": { - "type": "number", - "format": "float" - }, - "totalComparisonBudget": { - "type": "integer", - "format": "int32" - }, - "currentComparisonBudget": { - "type": "integer", - "format": "int32" - } - } - }, - "IRankingConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRankingConfigBradleyTerryRankingConfig" - }, - { - "$ref": "#/components/schemas/IRankingConfigEloConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BradleyTerryRankingConfig": "#/components/schemas/IRankingConfigBradleyTerryRankingConfig", - "EloConfig": "#/components/schemas/IRankingConfigEloConfig" - } - } - }, - "IRankingConfigBradleyTerryRankingConfig": { - "required": [ - "startingScore", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BradleyTerryRankingConfig" - ], - "type": "string" - }, - "startingScore": { - "type": "integer", - "format": "int32" - } - } - }, - "IRankingConfigEloConfig": { - "required": [ - "startingScore", - "kFactor", - "scalingFactor", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "EloConfig" - ], - "type": "string" - }, - "startingScore": { - "type": "integer", - "format": "int32" - }, - "kFactor": { - "type": "integer", - "format": "int32" - }, - "scalingFactor": { - "type": "integer", - "format": "int32" - } - } - }, - "IRapidPayload": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRapidPayloadBoundingBoxPayload" - }, - { - "$ref": "#/components/schemas/IRapidPayloadClassifyPayload" - }, - { - "$ref": "#/components/schemas/IRapidPayloadComparePayload" - }, - { - "$ref": "#/components/schemas/IRapidPayloadFreeTextPayload" - }, - { - "$ref": "#/components/schemas/IRapidPayloadLinePayload" - }, - { - "$ref": "#/components/schemas/IRapidPayloadLocatePayload" - }, - { - "$ref": "#/components/schemas/IRapidPayloadNamedEntityPayload" - }, - { - "$ref": "#/components/schemas/IRapidPayloadPolygonPayload" - }, - { - "$ref": "#/components/schemas/IRapidPayloadScrubPayload" - }, - { - "$ref": "#/components/schemas/IRapidPayloadTranscriptionPayload" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BoundingBoxPayload": "#/components/schemas/IRapidPayloadBoundingBoxPayload", - "ClassifyPayload": "#/components/schemas/IRapidPayloadClassifyPayload", - "ComparePayload": "#/components/schemas/IRapidPayloadComparePayload", - "FreeTextPayload": "#/components/schemas/IRapidPayloadFreeTextPayload", - "LinePayload": "#/components/schemas/IRapidPayloadLinePayload", - "LocatePayload": "#/components/schemas/IRapidPayloadLocatePayload", - "NamedEntityPayload": "#/components/schemas/IRapidPayloadNamedEntityPayload", - "PolygonPayload": "#/components/schemas/IRapidPayloadPolygonPayload", - "ScrubPayload": "#/components/schemas/IRapidPayloadScrubPayload", - "TranscriptionPayload": "#/components/schemas/IRapidPayloadTranscriptionPayload" - } - } - }, - "IRapidPayloadBoundingBoxPayload": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BoundingBoxPayload" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidPayloadClassifyPayload": { - "required": [ - "categories", - "title", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyPayload" - ], - "type": "string" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ClassifyPayload_Category" - } - }, - "title": { - "type": "string" - } - } - }, - "IRapidPayloadComparePayload": { - "required": [ - "criteria", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ComparePayload" - ], - "type": "string" - }, - "criteria": { - "type": "string" - } - } - }, - "IRapidPayloadFreeTextPayload": { - "required": [ - "question", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FreeTextPayload" - ], - "type": "string" - }, - "question": { - "type": "string" - }, - "shouldValidateResponse": { - "type": "boolean" - }, - "validationSystemPrompt": { - "type": "string", - "nullable": true - } - } - }, - "IRapidPayloadLinePayload": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LinePayload" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidPayloadLocatePayload": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocatePayload" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidPayloadNamedEntityPayload": { - "required": [ - "target", - "classes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NamedEntityPayload" - ], - "type": "string" - }, - "target": { - "type": "string" - }, - "classes": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IRapidPayloadPolygonPayload": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonPayload" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidPayloadScrubPayload": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScrubPayload" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IRapidPayloadTranscriptionPayload": { - "required": [ - "title", - "transcription", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TranscriptionPayload" - ], - "type": "string" - }, - "title": { - "type": "string" - }, - "transcription": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionPayload_TranscriptionWord" - } - } - } - }, - "IRapidResult": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRapidResultAttachCategoryResult" - }, - { - "$ref": "#/components/schemas/IRapidResultBoundingBoxResult" - }, - { - "$ref": "#/components/schemas/IRapidResultCompareResult" - }, - { - "$ref": "#/components/schemas/IRapidResultFreeTextResult" - }, - { - "$ref": "#/components/schemas/IRapidResultLineResult" - }, - { - "$ref": "#/components/schemas/IRapidResultLocateResult" - }, - { - "$ref": "#/components/schemas/IRapidResultNamedEntityResult" - }, - { - "$ref": "#/components/schemas/IRapidResultPolygonResult" - }, - { - "$ref": "#/components/schemas/IRapidResultScrubResult" - }, - { - "$ref": "#/components/schemas/IRapidResultSkipResult" - }, - { - "$ref": "#/components/schemas/IRapidResultTranscriptionResult" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "AttachCategoryResult": "#/components/schemas/IRapidResultAttachCategoryResult", - "BoundingBoxResult": "#/components/schemas/IRapidResultBoundingBoxResult", - "CompareResult": "#/components/schemas/IRapidResultCompareResult", - "FreeTextResult": "#/components/schemas/IRapidResultFreeTextResult", - "LineResult": "#/components/schemas/IRapidResultLineResult", - "LocateResult": "#/components/schemas/IRapidResultLocateResult", - "NamedEntityResult": "#/components/schemas/IRapidResultNamedEntityResult", - "PolygonResult": "#/components/schemas/IRapidResultPolygonResult", - "ScrubResult": "#/components/schemas/IRapidResultScrubResult", - "SkipResult": "#/components/schemas/IRapidResultSkipResult", - "TranscriptionResult": "#/components/schemas/IRapidResultTranscriptionResult" - } - } - }, - "IRapidResultAttachCategoryResult": { - "required": [ - "rapidId", - "category", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "AttachCategoryResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "category": { - "type": "string" - } - } - }, - "IRapidResultBoundingBoxResult": { - "required": [ - "rapidId", - "boundingBoxes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BoundingBoxResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "boundingBoxes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BoundingBoxResult_Box" - } - } - } - }, - "IRapidResultCompareResult": { - "required": [ - "rapidId", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CompareResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "winners": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IRapidResultFreeTextResult": { - "required": [ - "rapidId", - "answer", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FreeTextResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "answer": { - "type": "string" - } - } - }, - "IRapidResultLineResult": { - "required": [ - "rapidId", - "lines", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LineResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "lines": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineResult_Line" - } - } - } - }, - "IRapidResultLocateResult": { - "required": [ - "rapidId", - "coordinates", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocateResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "coordinates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LocateCoordinate" - } - } - } - }, - "IRapidResultNamedEntityResult": { - "required": [ - "rapidId", - "classifications", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NamedEntityResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NamedEntityResult_NamedClassification" - } - } - } - }, - "IRapidResultPolygonResult": { - "required": [ - "rapidId", - "shapes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "shapes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PolygonResult_Shape" - } - } - } - }, - "IRapidResultScrubResult": { - "required": [ - "rapidId", - "timestamps", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScrubResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "timestamps": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - } - } - }, - "IRapidResultSkipResult": { - "required": [ - "rapidId", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "SkipResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - } - } - }, - "IRapidResultTranscriptionResult": { - "required": [ - "rapidId", - "selectedWords", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TranscriptionResult" - ], - "type": "string" - }, - "rapidId": { - "type": "string" - }, - "selectedWords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TranscriptionResult_TranscriptionWord" - } - } - } - }, - "IRefereeConfig": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRefereeConfigBudgetRefereeConfig" - }, - { - "$ref": "#/components/schemas/IRefereeConfigNaiveRefereeConfig" - }, - { - "$ref": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig" - }, - { - "$ref": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig" - }, - { - "$ref": "#/components/schemas/IRefereeConfigQuorumRefereeConfig" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "BudgetRefereeConfig": "#/components/schemas/IRefereeConfigBudgetRefereeConfig", - "NaiveRefereeConfig": "#/components/schemas/IRefereeConfigNaiveRefereeConfig", - "NeverEndingRefereeConfig": "#/components/schemas/IRefereeConfigNeverEndingRefereeConfig", - "ProbabilisticAttachCategoryRefereeConfig": "#/components/schemas/IRefereeConfigProbabilisticAttachCategoryRefereeConfig", - "QuorumRefereeConfig": "#/components/schemas/IRefereeConfigQuorumRefereeConfig" - } - } - }, - "IRefereeConfigBudgetRefereeConfig": { - "required": [ - "totalBudget", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BudgetRefereeConfig" - ], - "type": "string" - }, - "totalBudget": { - "type": "integer", - "format": "int32" - }, - "totalServeBudget": { - "type": "integer", - "format": "int32", - "nullable": true - } - } - }, - "IRefereeConfigNaiveRefereeConfig": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NaiveRefereeConfig" - ], - "type": "string" - }, - "responsesRequired": { - "type": "integer", - "format": "int32" - }, - "guessesRequired": { - "type": "integer", - "format": "int32", - "deprecated": true - } - } - }, - "IRefereeConfigNeverEndingRefereeConfig": { - "required": [ - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NeverEndingRefereeConfig" - ], - "type": "string" - } - } - }, - "IRefereeConfigProbabilisticAttachCategoryRefereeConfig": { - "required": [ - "threshold", - "maxVotes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ProbabilisticAttachCategoryRefereeConfig" - ], - "type": "string" - }, - "threshold": { - "type": "number", - "format": "double" - }, - "maxVotes": { - "type": "integer", - "format": "int32" - } - } - }, - "IRefereeConfigQuorumRefereeConfig": { - "required": [ - "maxVotes", - "threshold", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "QuorumRefereeConfig" - ], - "type": "string" - }, - "maxVotes": { - "type": "integer", - "format": "int32" - }, - "threshold": { - "type": "integer", - "format": "int32" - } - } - }, - "IResponseAggregation": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IResponseAggregationClassifyAggregation" - }, - { - "$ref": "#/components/schemas/IResponseAggregationCompareAggregation" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassifyAggregation": "#/components/schemas/IResponseAggregationClassifyAggregation", - "CompareAggregation": "#/components/schemas/IResponseAggregationCompareAggregation" - } - } - }, - "IResponseAggregationClassifyAggregation": { - "required": [ - "categoryTallies", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyAggregation" - ], - "type": "string" - }, - "categoryTallies": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ResponseTally" - } - } - } - }, - "IResponseAggregationCompareAggregation": { - "required": [ - "winnerTallies", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CompareAggregation" - ], - "type": "string" - }, - "winnerTallies": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ResponseTally" - } - } - } - }, - "IWorkflow": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IWorkflowEvaluationWorkflow" - }, - { - "$ref": "#/components/schemas/IWorkflowGroupedRankingWorkflow" - }, - { - "$ref": "#/components/schemas/IWorkflowRankingWorkflow" - }, - { - "$ref": "#/components/schemas/IWorkflowSimpleWorkflow" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "EvaluationWorkflow": "#/components/schemas/IWorkflowEvaluationWorkflow", - "GroupedRankingWorkflowModel": "#/components/schemas/IWorkflowGroupedRankingWorkflow", - "RankingWorkflowModel": "#/components/schemas/IWorkflowRankingWorkflow", - "SimpleWorkflowModel": "#/components/schemas/IWorkflowSimpleWorkflow" - } - } - }, - "IWorkflowEvaluationWorkflow": { - "required": [ - "id", - "validationSetId", - "state", - "referee", - "name", - "ownerMail", - "organizationId", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "EvaluationWorkflow" - ], - "type": "string" - }, - "id": { - "type": "string" - }, - "validationSetId": { - "type": "string" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "name": { - "type": "string" - }, - "ownerMail": { - "type": "string", - "nullable": true - }, - "organizationId": { - "type": "string" - } - } - }, - "IWorkflowGroupedRankingWorkflow": { - "required": [ - "id", - "referee", - "state", - "criteria", - "name", - "ownerMail", - "organizationId", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "GroupedRankingWorkflowModel" - ], - "type": "string" - }, - "id": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "criteria": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ownerMail": { - "type": "string", - "nullable": true - }, - "organizationId": { - "type": "string" - }, - "rankingConfig": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRankingConfig" - } - ], - "nullable": true - } - } - }, - "IWorkflowRankingWorkflow": { - "required": [ - "id", - "referee", - "pairMakerInformation", - "state", - "criteria", - "name", - "context", - "contextAsset", - "ownerMail", - "organizationId", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "RankingWorkflowModel" - ], - "type": "string" - }, - "id": { - "type": "string" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "pairMakerInformation": { - "$ref": "#/components/schemas/IPairMakerInformation" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "criteria": { - "type": "string" - }, - "name": { - "type": "string" - }, - "rankingConfig": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IRankingConfig" - } - ], - "nullable": true - }, - "context": { - "type": "string", - "nullable": true - }, - "contextAsset": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IAsset" - } - ], - "nullable": true - }, - "ownerMail": { - "type": "string", - "nullable": true - }, - "organizationId": { - "type": "string" - } - } - }, - "IWorkflowRapidBlueprint": { - "required": [ - "_t" - ], - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintLineWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint" - }, - { - "$ref": "#/components/schemas/IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint" - } - ], - "discriminator": { - "propertyName": "_t", - "mapping": { - "ClassifyBlueprint": "#/components/schemas/IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint", - "BoundingBoxBlueprint": "#/components/schemas/IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint", - "CompareBlueprint": "#/components/schemas/IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint", - "FreeTextBlueprint": "#/components/schemas/IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint", - "LineBlueprint": "#/components/schemas/IWorkflowRapidBlueprintLineWorkflowRapidBlueprint", - "LocateBlueprint": "#/components/schemas/IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint", - "NamedEntityBlueprint": "#/components/schemas/IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint", - "PolygonBlueprint": "#/components/schemas/IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint", - "ScrubBlueprint": "#/components/schemas/IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint", - "TranscriptionBlueprint": "#/components/schemas/IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint" - } - } - }, - "IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint": { - "required": [ - "categories", - "title", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ClassifyBlueprint" - ], - "type": "string" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttachCategoryWorkflowRapidBlueprint_Category" - } - }, - "title": { - "type": "string" - } - } - }, - "IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "BoundingBoxBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint": { - "required": [ - "criteria", - "indexIdentifiers", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "CompareBlueprint" - ], - "type": "string" - }, - "criteria": { - "type": "string" - }, - "indexIdentifiers": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint": { - "required": [ - "question", - "shouldValidateResponse", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "FreeTextBlueprint" - ], - "type": "string" - }, - "question": { - "type": "string" - }, - "shouldValidateResponse": { - "type": "boolean" - }, - "validationSystemPrompt": { - "type": "string", - "nullable": true - } - } - }, - "IWorkflowRapidBlueprintLineWorkflowRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LineBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "LocateBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint": { - "required": [ - "target", - "classes", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "NamedEntityBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - }, - "classes": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "PolygonBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint": { - "required": [ - "target", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "ScrubBlueprint" - ], - "type": "string" - }, - "target": { - "type": "string" - } - } - }, - "IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint": { - "required": [ - "title", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "TranscriptionBlueprint" - ], - "type": "string" - }, - "title": { - "type": "string" - } - } - }, - "IWorkflowSimpleWorkflow": { - "required": [ - "id", - "state", - "blueprint", - "referee", - "name", - "ownerMail", - "organizationId", - "_t" - ], - "properties": { - "_t": { - "enum": [ - "SimpleWorkflowModel" - ], - "type": "string" - }, - "id": { - "type": "string" - }, - "state": { - "$ref": "#/components/schemas/WorkflowState" - }, - "blueprint": { - "$ref": "#/components/schemas/IWorkflowRapidBlueprint" - }, - "referee": { - "$ref": "#/components/schemas/IRefereeConfig" - }, - "name": { - "type": "string" - }, - "ownerMail": { - "type": "string", - "nullable": true - }, - "organizationId": { - "type": "string" - } - } - }, - "LineResult_Line": { - "required": [ - "size", - "points" - ], - "type": "object", - "properties": { - "size": { - "type": "number", - "format": "double" - }, - "points": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineResult_LinePoint" - } - } - } - }, - "LineResult_LinePoint": { - "required": [ - "x", - "y" - ], - "type": "object", - "properties": { - "x": { - "type": "number", - "format": "double" - }, - "y": { - "type": "number", - "format": "double" - } - } - }, - "LocateCoordinate": { - "required": [ - "x", - "y" - ], - "type": "object", - "properties": { - "x": { - "type": "number", - "format": "double" - }, - "y": { - "type": "number", - "format": "double" - } - } - }, - "MetadataModelCollection": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/IMetadata" - } - }, - "NamedEntityResult_NamedClassification": { - "required": [ - "start", - "end", - "classification" - ], - "type": "object", - "properties": { - "start": { - "type": "integer", - "format": "int32" - }, - "end": { - "type": "integer", - "format": "int32" - }, - "classification": { - "type": "string" - } - } - }, - "PolygonResult_Coordinate": { - "required": [ - "x", - "y" - ], - "type": "object", - "properties": { - "x": { - "type": "number", - "format": "double", - "nullable": true - }, - "y": { - "type": "number", - "format": "double", - "nullable": true - } - } - }, - "PolygonResult_Shape": { - "required": [ - "edges" - ], - "type": "object", - "properties": { - "edges": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PolygonResult_Coordinate" - } - } - } - }, - "QueryWorkflowsEndpoint_Output": { - "required": [ - "workflow" - ], - "type": "object", - "properties": { - "workflow": { - "allOf": [ - { - "$ref": "#/components/schemas/IWorkflow" - } - ], - "description": "The workflow." - } - } - }, - "QueryWorkflowsEndpoint_PagedResultOfOutput": { - "required": [ - "total", - "page", - "pageSize", - "items" - ], - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int64" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "pageSize": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryWorkflowsEndpoint_Output" - } - }, - "totalPages": { - "type": "integer", - "format": "int32" - } - } - }, - "RapidState": { - "enum": [ - "Labeling", - "Paused", - "Incomplete", - "Flagged", - "Done", - "None", - "Rejected" - ] - }, - "ResponseTally": { - "required": [ - "count", - "userScoreSum" - ], - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int64" - }, - "userScoreSum": { - "type": "number", - "format": "double" - } - } - }, - "SortDirection": { - "enum": [ - "Asc", - "Desc" - ] - }, - "TranscriptionPayload_TranscriptionWord": { - "required": [ - "word", - "wordIndex" - ], - "type": "object", - "properties": { - "word": { - "type": "string" - }, - "wordIndex": { - "type": "integer", - "format": "int32" - } - } - }, - "TranscriptionResult_TranscriptionWord": { - "required": [ - "word", - "wordIndex" - ], - "type": "object", - "properties": { - "word": { - "type": "string" - }, - "wordIndex": { - "type": "integer", - "format": "int32" - } - } - }, - "ValidationProblemDetails": { - "type": "object", - "properties": { - "type": { - "type": "string", - "nullable": true - }, - "title": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "instance": { - "type": "string", - "nullable": true - }, - "errors": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "WorkflowState": { - "enum": [ - "Created", - "Started", - "Labeling", - "Paused", - "Done", - "Failed" - ] - } - }, - "securitySchemes": { - "OpenIdConnect": { - "type": "openIdConnect", - "description": "OpenID Connect connection flow", - "openIdConnectUrl": "https://auth.rabbitdata.ch/.well-known/openid-configuration" - } - } - }, - "security": [ - { - "OpenIdConnect": [ - "openid", - "profile", - "email", - "offline_access" - ] - } - ] -} \ No newline at end of file diff --git a/src/rapidata/__init__.py b/src/rapidata/__init__.py index d170af2c6f..12195d1cb4 100644 --- a/src/rapidata/__init__.py +++ b/src/rapidata/__init__.py @@ -7,8 +7,6 @@ RapidataAudienceManager, RapidataFilteredAudience, RecruitingMetrics, - RapidataOrderManager, - RapidataOrder, RapidataJob, RapidataJobDefinition, RapidataJobManager, diff --git a/src/rapidata/api_client/__init__.py b/src/rapidata/api_client/__init__.py index aa66dc215a..823773570b 100644 --- a/src/rapidata/api_client/__init__.py +++ b/src/rapidata/api_client/__init__.py @@ -7,7 +7,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -65,7 +65,6 @@ "OwnerTierOverrideApi": "rapidata.api_client.api.owner_tier_override_api", "ParticipantApi": "rapidata.api_client.api.participant_api", "PaymentApi": "rapidata.api_client.api.payment_api", - "PipelineApi": "rapidata.api_client.api.pipeline_api", "PlatformApi": "rapidata.api_client.api.platform_api", "PromptApi": "rapidata.api_client.api.prompt_api", "PromptEmbeddingMapApi": "rapidata.api_client.api.prompt_embedding_map_api", @@ -85,7 +84,6 @@ "ValidationFeedbackApi": "rapidata.api_client.api.validation_feedback_api", "ValidationSetApi": "rapidata.api_client.api.validation_set_api", "VolumeDiscountApi": "rapidata.api_client.api.volume_discount_api", - "WorkflowApi": "rapidata.api_client.api.workflow_api", } # Import model mappings from the models subpackage (dynamically discovered) diff --git a/src/rapidata/api_client/api/__init__.py b/src/rapidata/api_client/api/__init__.py index 9dfea478a8..51e0a5dbf0 100644 --- a/src/rapidata/api_client/api/__init__.py +++ b/src/rapidata/api_client/api/__init__.py @@ -38,7 +38,6 @@ from rapidata.api_client.api.owner_tier_override_api import OwnerTierOverrideApi from rapidata.api_client.api.participant_api import ParticipantApi from rapidata.api_client.api.payment_api import PaymentApi -from rapidata.api_client.api.pipeline_api import PipelineApi from rapidata.api_client.api.platform_api import PlatformApi from rapidata.api_client.api.prompt_api import PromptApi from rapidata.api_client.api.prompt_embedding_map_api import PromptEmbeddingMapApi @@ -58,5 +57,4 @@ from rapidata.api_client.api.validation_feedback_api import ValidationFeedbackApi from rapidata.api_client.api.validation_set_api import ValidationSetApi from rapidata.api_client.api.volume_discount_api import VolumeDiscountApi -from rapidata.api_client.api.workflow_api import WorkflowApi diff --git a/src/rapidata/api_client/api/asset_api.py b/src/rapidata/api_client/api/asset_api.py index 14efaffae5..cd5a2d64ec 100644 --- a/src/rapidata/api_client/api/asset_api.py +++ b/src/rapidata/api_client/api/asset_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/audience_api.py b/src/rapidata/api_client/api/audience_api.py index b8a5fd49ea..5f82cc2f1f 100644 --- a/src/rapidata/api_client/api/audience_api.py +++ b/src/rapidata/api_client/api/audience_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/batch_upload_api.py b/src/rapidata/api_client/api/batch_upload_api.py index e8e793a2f1..9cf9c8044b 100644 --- a/src/rapidata/api_client/api/batch_upload_api.py +++ b/src/rapidata/api_client/api/batch_upload_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/benchmark_api.py b/src/rapidata/api_client/api/benchmark_api.py index 1063412826..85938ea7f6 100644 --- a/src/rapidata/api_client/api/benchmark_api.py +++ b/src/rapidata/api_client/api/benchmark_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/bidder_api.py b/src/rapidata/api_client/api/bidder_api.py index bd839fbad9..616f1f47b4 100644 --- a/src/rapidata/api_client/api/bidder_api.py +++ b/src/rapidata/api_client/api/bidder_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/billing_account_api.py b/src/rapidata/api_client/api/billing_account_api.py index 8d3fa85848..31dac4d687 100644 --- a/src/rapidata/api_client/api/billing_account_api.py +++ b/src/rapidata/api_client/api/billing_account_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/billing_api.py b/src/rapidata/api_client/api/billing_api.py index 96c10683c3..a53c5fd121 100644 --- a/src/rapidata/api_client/api/billing_api.py +++ b/src/rapidata/api_client/api/billing_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/cache_api.py b/src/rapidata/api_client/api/cache_api.py index f707671ad4..e7af77e2c1 100644 --- a/src/rapidata/api_client/api/cache_api.py +++ b/src/rapidata/api_client/api/cache_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/campaign_api.py b/src/rapidata/api_client/api/campaign_api.py index 5d507eca58..af50d2a0bd 100644 --- a/src/rapidata/api_client/api/campaign_api.py +++ b/src/rapidata/api_client/api/campaign_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/capabilities_api.py b/src/rapidata/api_client/api/capabilities_api.py index 9b30d3689d..b7f66ab25d 100644 --- a/src/rapidata/api_client/api/capabilities_api.py +++ b/src/rapidata/api_client/api/capabilities_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/client_api.py b/src/rapidata/api_client/api/client_api.py index 072dddda4d..7c7f77c1ed 100644 --- a/src/rapidata/api_client/api/client_api.py +++ b/src/rapidata/api_client/api/client_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/compare_workflow_api.py b/src/rapidata/api_client/api/compare_workflow_api.py deleted file mode 100644 index a0c0fdacce..0000000000 --- a/src/rapidata/api_client/api/compare_workflow_api.py +++ /dev/null @@ -1,319 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -import warnings -from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt -from typing import Any, Dict, List, Optional, Tuple, Union -from typing_extensions import Annotated - -from pydantic import Field, StrictStr -from typing import Optional -from typing_extensions import Annotated -from rapidata.api_client.models.get_compare_workflow_results_model import GetCompareWorkflowResultsModel -from rapidata.api_client.models.get_compare_workflow_results_result import GetCompareWorkflowResultsResult - -from rapidata.api_client.api_client import ApiClient, RequestSerialized -from rapidata.api_client.api_response import ApiResponse -from rapidata.api_client.rest import RESTResponseType - - -class CompareWorkflowApi: - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None) -> None: - if api_client is None: - api_client = ApiClient.get_default() - self.api_client = api_client - - - @validate_call - def workflow_compare_workflow_id_results_get( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[GetCompareWorkflowResultsModel], Field(description="The model for the request.")] = 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, - ) -> GetCompareWorkflowResultsResult: - """Get the result overview for a compare workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The model for the request. - :type model: GetCompareWorkflowResultsModel - :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._workflow_compare_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetCompareWorkflowResultsResult", - } - 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 workflow_compare_workflow_id_results_get_with_http_info( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[GetCompareWorkflowResultsModel], Field(description="The model for the request.")] = 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[GetCompareWorkflowResultsResult]: - """Get the result overview for a compare workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The model for the request. - :type model: GetCompareWorkflowResultsModel - :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._workflow_compare_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetCompareWorkflowResultsResult", - } - 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 workflow_compare_workflow_id_results_get_without_preload_content( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[GetCompareWorkflowResultsModel], Field(description="The model for the request.")] = 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: - """Get the result overview for a compare workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The model for the request. - :type model: GetCompareWorkflowResultsModel - :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._workflow_compare_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetCompareWorkflowResultsResult", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _workflow_compare_workflow_id_results_get_serialize( - self, - workflow_id, - model, - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if workflow_id is not None: - _path_params['workflowId'] = workflow_id - # process the query parameters - if model is not None: - - _query_params.append(('model', model)) - - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'text/plain', - 'application/json', - 'text/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OAuth2', - 'OpenIdConnect', - 'Bearer' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/workflow/compare/{workflowId}/results', - 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 - ) - - diff --git a/src/rapidata/api_client/api/context_shortening_api.py b/src/rapidata/api_client/api/context_shortening_api.py index c41cd9ee59..0932edd697 100644 --- a/src/rapidata/api_client/api/context_shortening_api.py +++ b/src/rapidata/api_client/api/context_shortening_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/customer_api.py b/src/rapidata/api_client/api/customer_api.py index ed4f3fbbab..2b094d0139 100644 --- a/src/rapidata/api_client/api/customer_api.py +++ b/src/rapidata/api_client/api/customer_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/customer_rapid_api.py b/src/rapidata/api_client/api/customer_rapid_api.py index 48c8fd8f31..306fd222e9 100644 --- a/src/rapidata/api_client/api/customer_rapid_api.py +++ b/src/rapidata/api_client/api/customer_rapid_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/datapoints_api.py b/src/rapidata/api_client/api/datapoints_api.py index 23cbd0cad6..443b4e7237 100644 --- a/src/rapidata/api_client/api/datapoints_api.py +++ b/src/rapidata/api_client/api/datapoints_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/dataset_api.py b/src/rapidata/api_client/api/dataset_api.py index cbba68169a..b03cbd4d28 100644 --- a/src/rapidata/api_client/api/dataset_api.py +++ b/src/rapidata/api_client/api/dataset_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/dataset_group_api.py b/src/rapidata/api_client/api/dataset_group_api.py index b9fbeb42bd..a89655756d 100644 --- a/src/rapidata/api_client/api/dataset_group_api.py +++ b/src/rapidata/api_client/api/dataset_group_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/evaluation_workflow_api.py b/src/rapidata/api_client/api/evaluation_workflow_api.py deleted file mode 100644 index 70ab9e9474..0000000000 --- a/src/rapidata/api_client/api/evaluation_workflow_api.py +++ /dev/null @@ -1,319 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -import warnings -from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt -from typing import Any, Dict, List, Optional, Tuple, Union -from typing_extensions import Annotated - -from pydantic import Field, StrictStr -from typing import Optional -from typing_extensions import Annotated -from rapidata.api_client.models.get_evaluation_workflow_results_model import GetEvaluationWorkflowResultsModel -from rapidata.api_client.models.paged_result_of_get_workflow_results_result import PagedResultOfGetWorkflowResultsResult - -from rapidata.api_client.api_client import ApiClient, RequestSerialized -from rapidata.api_client.api_response import ApiResponse -from rapidata.api_client.rest import RESTResponseType - - -class EvaluationWorkflowApi: - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None) -> None: - if api_client is None: - api_client = ApiClient.get_default() - self.api_client = api_client - - - @validate_call - def workflow_evaluation_workflow_id_results_get( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[GetEvaluationWorkflowResultsModel], Field(description="The body of the request.")] = 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, - ) -> PagedResultOfGetWorkflowResultsResult: - """Get the results for an evaluation workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The body of the request. - :type model: GetEvaluationWorkflowResultsModel - :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._workflow_evaluation_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PagedResultOfGetWorkflowResultsResult", - } - 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 workflow_evaluation_workflow_id_results_get_with_http_info( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[GetEvaluationWorkflowResultsModel], Field(description="The body of the request.")] = 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[PagedResultOfGetWorkflowResultsResult]: - """Get the results for an evaluation workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The body of the request. - :type model: GetEvaluationWorkflowResultsModel - :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._workflow_evaluation_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PagedResultOfGetWorkflowResultsResult", - } - 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 workflow_evaluation_workflow_id_results_get_without_preload_content( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[GetEvaluationWorkflowResultsModel], Field(description="The body of the request.")] = 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: - """Get the results for an evaluation workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The body of the request. - :type model: GetEvaluationWorkflowResultsModel - :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._workflow_evaluation_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PagedResultOfGetWorkflowResultsResult", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _workflow_evaluation_workflow_id_results_get_serialize( - self, - workflow_id, - model, - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if workflow_id is not None: - _path_params['workflowId'] = workflow_id - # process the query parameters - if model is not None: - - _query_params.append(('model', model)) - - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'text/plain', - 'application/json', - 'text/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OAuth2', - 'OpenIdConnect', - 'Bearer' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/workflow/evaluation/{workflowId}/results', - 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 - ) - - diff --git a/src/rapidata/api_client/api/examples_api.py b/src/rapidata/api_client/api/examples_api.py index 861195d3ea..36a802b878 100644 --- a/src/rapidata/api_client/api/examples_api.py +++ b/src/rapidata/api_client/api/examples_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/external_apps_api.py b/src/rapidata/api_client/api/external_apps_api.py index 68e7db0f64..868e5fbedd 100644 --- a/src/rapidata/api_client/api/external_apps_api.py +++ b/src/rapidata/api_client/api/external_apps_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/external_audience_api.py b/src/rapidata/api_client/api/external_audience_api.py index 1c674614f6..f615225df4 100644 --- a/src/rapidata/api_client/api/external_audience_api.py +++ b/src/rapidata/api_client/api/external_audience_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/external_service_prices_api.py b/src/rapidata/api_client/api/external_service_prices_api.py index beb94e0242..3cf8c4b8ed 100644 --- a/src/rapidata/api_client/api/external_service_prices_api.py +++ b/src/rapidata/api_client/api/external_service_prices_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/faucet_api.py b/src/rapidata/api_client/api/faucet_api.py index f901036135..c786e5a7c4 100644 --- a/src/rapidata/api_client/api/faucet_api.py +++ b/src/rapidata/api_client/api/faucet_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/feedback_api.py b/src/rapidata/api_client/api/feedback_api.py index 70a358fb43..9215817f1b 100644 --- a/src/rapidata/api_client/api/feedback_api.py +++ b/src/rapidata/api_client/api/feedback_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/flow_api.py b/src/rapidata/api_client/api/flow_api.py index a9c59ee2f4..a7a951439e 100644 --- a/src/rapidata/api_client/api/flow_api.py +++ b/src/rapidata/api_client/api/flow_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/flow_item_api.py b/src/rapidata/api_client/api/flow_item_api.py index 0803dda907..3bbe97adb4 100644 --- a/src/rapidata/api_client/api/flow_item_api.py +++ b/src/rapidata/api_client/api/flow_item_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/global_text_api.py b/src/rapidata/api_client/api/global_text_api.py index ed3dcb7bbc..cb8bd70a57 100644 --- a/src/rapidata/api_client/api/global_text_api.py +++ b/src/rapidata/api_client/api/global_text_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/grouped_ranking_workflow_api.py b/src/rapidata/api_client/api/grouped_ranking_workflow_api.py deleted file mode 100644 index 914c214676..0000000000 --- a/src/rapidata/api_client/api/grouped_ranking_workflow_api.py +++ /dev/null @@ -1,319 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -import warnings -from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt -from typing import Any, Dict, List, Optional, Tuple, Union -from typing_extensions import Annotated - -from pydantic import Field, StrictStr -from typing import Optional -from typing_extensions import Annotated -from rapidata.api_client.models.paged_result_of_get_grouped_ranking_workflow_results_result import PagedResultOfGetGroupedRankingWorkflowResultsResult -from rapidata.api_client.models.query_model import QueryModel - -from rapidata.api_client.api_client import ApiClient, RequestSerialized -from rapidata.api_client.api_response import ApiResponse -from rapidata.api_client.rest import RESTResponseType - - -class GroupedRankingWorkflowApi: - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None) -> None: - if api_client is None: - api_client = ApiClient.get_default() - self.api_client = api_client - - - @validate_call - def workflow_grouped_ranking_workflow_id_results_get( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[QueryModel], Field(description="The model for the request.")] = 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, - ) -> PagedResultOfGetGroupedRankingWorkflowResultsResult: - """Get the result overview for a multi ranking workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The model for the request. - :type model: QueryModel - :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._workflow_grouped_ranking_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PagedResultOfGetGroupedRankingWorkflowResultsResult", - } - 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 workflow_grouped_ranking_workflow_id_results_get_with_http_info( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[QueryModel], Field(description="The model for the request.")] = 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[PagedResultOfGetGroupedRankingWorkflowResultsResult]: - """Get the result overview for a multi ranking workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The model for the request. - :type model: QueryModel - :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._workflow_grouped_ranking_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PagedResultOfGetGroupedRankingWorkflowResultsResult", - } - 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 workflow_grouped_ranking_workflow_id_results_get_without_preload_content( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[QueryModel], Field(description="The model for the request.")] = 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: - """Get the result overview for a multi ranking workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The model for the request. - :type model: QueryModel - :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._workflow_grouped_ranking_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "PagedResultOfGetGroupedRankingWorkflowResultsResult", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _workflow_grouped_ranking_workflow_id_results_get_serialize( - self, - workflow_id, - model, - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if workflow_id is not None: - _path_params['workflowId'] = workflow_id - # process the query parameters - if model is not None: - - _query_params.append(('model', model)) - - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'text/plain', - 'application/json', - 'text/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OAuth2', - 'OpenIdConnect', - 'Bearer' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/workflow/grouped-ranking/{workflowId}/results', - 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 - ) - - diff --git a/src/rapidata/api_client/api/hugging_face_sync_api.py b/src/rapidata/api_client/api/hugging_face_sync_api.py index b2d4ac5deb..aba2d7ef92 100644 --- a/src/rapidata/api_client/api/hugging_face_sync_api.py +++ b/src/rapidata/api_client/api/hugging_face_sync_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/identity_api.py b/src/rapidata/api_client/api/identity_api.py index 8b00db3399..624e9b5be0 100644 --- a/src/rapidata/api_client/api/identity_api.py +++ b/src/rapidata/api_client/api/identity_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/invoice_api.py b/src/rapidata/api_client/api/invoice_api.py index 3bcfc83f3e..b6b818fb88 100644 --- a/src/rapidata/api_client/api/invoice_api.py +++ b/src/rapidata/api_client/api/invoice_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/job_api.py b/src/rapidata/api_client/api/job_api.py index c5921f3438..37e18e51e2 100644 --- a/src/rapidata/api_client/api/job_api.py +++ b/src/rapidata/api_client/api/job_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/leaderboard_api.py b/src/rapidata/api_client/api/leaderboard_api.py index 17cdbaf439..b71e34629f 100644 --- a/src/rapidata/api_client/api/leaderboard_api.py +++ b/src/rapidata/api_client/api/leaderboard_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/newsletter_api.py b/src/rapidata/api_client/api/newsletter_api.py index 09b21920bd..c96d30b5e8 100644 --- a/src/rapidata/api_client/api/newsletter_api.py +++ b/src/rapidata/api_client/api/newsletter_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/order_api.py b/src/rapidata/api_client/api/order_api.py index 34409b4898..e5033b674f 100644 --- a/src/rapidata/api_client/api/order_api.py +++ b/src/rapidata/api_client/api/order_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/organization_api.py b/src/rapidata/api_client/api/organization_api.py index ed6ea25b5d..2187f0e475 100644 --- a/src/rapidata/api_client/api/organization_api.py +++ b/src/rapidata/api_client/api/organization_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/owner_tier_override_api.py b/src/rapidata/api_client/api/owner_tier_override_api.py index 96ff2e791e..3a8a7a070c 100644 --- a/src/rapidata/api_client/api/owner_tier_override_api.py +++ b/src/rapidata/api_client/api/owner_tier_override_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/participant_api.py b/src/rapidata/api_client/api/participant_api.py index 465ff373f4..1cd64647a5 100644 --- a/src/rapidata/api_client/api/participant_api.py +++ b/src/rapidata/api_client/api/participant_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/payment_api.py b/src/rapidata/api_client/api/payment_api.py index 4e799d69d3..2870e004ac 100644 --- a/src/rapidata/api_client/api/payment_api.py +++ b/src/rapidata/api_client/api/payment_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/pipeline_api.py b/src/rapidata/api_client/api/pipeline_api.py deleted file mode 100644 index 0cd678d7b7..0000000000 --- a/src/rapidata/api_client/api/pipeline_api.py +++ /dev/null @@ -1,877 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 -import warnings -from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt -from typing import Any, Dict, List, Optional, Tuple, Union -from typing_extensions import Annotated - -from pydantic import Field, StrictStr -from typing_extensions import Annotated -from rapidata.api_client.models.get_pipeline_by_id_endpoint_output import GetPipelineByIdEndpointOutput -from rapidata.api_client.models.start_preliminary_download_endpoint_input import StartPreliminaryDownloadEndpointInput -from rapidata.api_client.models.start_preliminary_download_endpoint_output import StartPreliminaryDownloadEndpointOutput - -from rapidata.api_client.api_client import ApiClient, RequestSerialized -from rapidata.api_client.api_response import ApiResponse -from rapidata.api_client.rest import RESTResponseType - - -class PipelineApi: - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None) -> None: - if api_client is None: - api_client = ApiClient.get_default() - self.api_client = api_client - - - @validate_call - def pipeline_pipeline_id_get( - self, - pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to get.")], - _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, - ) -> GetPipelineByIdEndpointOutput: - """(Deprecated) Gets a pipeline by its id. - - - :param pipeline_id: The id of the pipeline to get. (required) - :type pipeline_id: 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 - warnings.warn("GET /pipeline/{pipelineId} is deprecated.", DeprecationWarning) - - _param = self._pipeline_pipeline_id_get_serialize( - pipeline_id=pipeline_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetPipelineByIdEndpointOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 pipeline_pipeline_id_get_with_http_info( - self, - pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to get.")], - _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[GetPipelineByIdEndpointOutput]: - """(Deprecated) Gets a pipeline by its id. - - - :param pipeline_id: The id of the pipeline to get. (required) - :type pipeline_id: 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 - warnings.warn("GET /pipeline/{pipelineId} is deprecated.", DeprecationWarning) - - _param = self._pipeline_pipeline_id_get_serialize( - pipeline_id=pipeline_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetPipelineByIdEndpointOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 pipeline_pipeline_id_get_without_preload_content( - self, - pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to get.")], - _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: - """(Deprecated) Gets a pipeline by its id. - - - :param pipeline_id: The id of the pipeline to get. (required) - :type pipeline_id: 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 - warnings.warn("GET /pipeline/{pipelineId} is deprecated.", DeprecationWarning) - - _param = self._pipeline_pipeline_id_get_serialize( - pipeline_id=pipeline_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetPipelineByIdEndpointOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _pipeline_pipeline_id_get_serialize( - self, - pipeline_id, - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if pipeline_id is not None: - _path_params['pipelineId'] = pipeline_id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OpenIdConnect' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/pipeline/{pipelineId}', - 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 pipeline_pipeline_id_preliminary_download_post( - self, - pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to initiate the download for.")], - start_preliminary_download_endpoint_input: Annotated[StartPreliminaryDownloadEndpointInput, Field(description="Whether to email the caller when the download is ready.")], - _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, - ) -> StartPreliminaryDownloadEndpointOutput: - """Initiates a preliminary download of the pipeline. - - - :param pipeline_id: The id of the pipeline to initiate the download for. (required) - :type pipeline_id: str - :param start_preliminary_download_endpoint_input: Whether to email the caller when the download is ready. (required) - :type start_preliminary_download_endpoint_input: StartPreliminaryDownloadEndpointInput - :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._pipeline_pipeline_id_preliminary_download_post_serialize( - pipeline_id=pipeline_id, - start_preliminary_download_endpoint_input=start_preliminary_download_endpoint_input, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StartPreliminaryDownloadEndpointOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 pipeline_pipeline_id_preliminary_download_post_with_http_info( - self, - pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to initiate the download for.")], - start_preliminary_download_endpoint_input: Annotated[StartPreliminaryDownloadEndpointInput, Field(description="Whether to email the caller when the download is ready.")], - _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[StartPreliminaryDownloadEndpointOutput]: - """Initiates a preliminary download of the pipeline. - - - :param pipeline_id: The id of the pipeline to initiate the download for. (required) - :type pipeline_id: str - :param start_preliminary_download_endpoint_input: Whether to email the caller when the download is ready. (required) - :type start_preliminary_download_endpoint_input: StartPreliminaryDownloadEndpointInput - :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._pipeline_pipeline_id_preliminary_download_post_serialize( - pipeline_id=pipeline_id, - start_preliminary_download_endpoint_input=start_preliminary_download_endpoint_input, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StartPreliminaryDownloadEndpointOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 pipeline_pipeline_id_preliminary_download_post_without_preload_content( - self, - pipeline_id: Annotated[StrictStr, Field(description="The id of the pipeline to initiate the download for.")], - start_preliminary_download_endpoint_input: Annotated[StartPreliminaryDownloadEndpointInput, Field(description="Whether to email the caller when the download is ready.")], - _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: - """Initiates a preliminary download of the pipeline. - - - :param pipeline_id: The id of the pipeline to initiate the download for. (required) - :type pipeline_id: str - :param start_preliminary_download_endpoint_input: Whether to email the caller when the download is ready. (required) - :type start_preliminary_download_endpoint_input: StartPreliminaryDownloadEndpointInput - :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._pipeline_pipeline_id_preliminary_download_post_serialize( - pipeline_id=pipeline_id, - start_preliminary_download_endpoint_input=start_preliminary_download_endpoint_input, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "StartPreliminaryDownloadEndpointOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _pipeline_pipeline_id_preliminary_download_post_serialize( - self, - pipeline_id, - start_preliminary_download_endpoint_input, - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if pipeline_id is not None: - _path_params['pipelineId'] = pipeline_id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if start_preliminary_download_endpoint_input is not None: - _body_params = start_preliminary_download_endpoint_input - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _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] = [ - 'OpenIdConnect' - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/pipeline/{pipelineId}/preliminary-download', - 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 pipeline_preliminary_download_preliminary_download_id_get( - self, - preliminary_download_id: Annotated[StrictStr, Field(description="The id of the preliminary download to get.")], - _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, - ) -> str: - """Streams the preliminary download file when ready. - - Returns 202 while the download is still processing. - - :param preliminary_download_id: The id of the preliminary download to get. (required) - :type preliminary_download_id: 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._pipeline_preliminary_download_preliminary_download_id_get_serialize( - preliminary_download_id=preliminary_download_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "str", - '202': None, - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 pipeline_preliminary_download_preliminary_download_id_get_with_http_info( - self, - preliminary_download_id: Annotated[StrictStr, Field(description="The id of the preliminary download to get.")], - _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[str]: - """Streams the preliminary download file when ready. - - Returns 202 while the download is still processing. - - :param preliminary_download_id: The id of the preliminary download to get. (required) - :type preliminary_download_id: 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._pipeline_preliminary_download_preliminary_download_id_get_serialize( - preliminary_download_id=preliminary_download_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "str", - '202': None, - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 pipeline_preliminary_download_preliminary_download_id_get_without_preload_content( - self, - preliminary_download_id: Annotated[StrictStr, Field(description="The id of the preliminary download to get.")], - _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: - """Streams the preliminary download file when ready. - - Returns 202 while the download is still processing. - - :param preliminary_download_id: The id of the preliminary download to get. (required) - :type preliminary_download_id: 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._pipeline_preliminary_download_preliminary_download_id_get_serialize( - preliminary_download_id=preliminary_download_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "str", - '202': None, - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _pipeline_preliminary_download_preliminary_download_id_get_serialize( - self, - preliminary_download_id, - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if preliminary_download_id is not None: - _path_params['preliminaryDownloadId'] = preliminary_download_id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OpenIdConnect' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/pipeline/preliminary-download/{preliminaryDownloadId}', - 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 - ) - - diff --git a/src/rapidata/api_client/api/platform_api.py b/src/rapidata/api_client/api/platform_api.py index 26c5c507e3..82133b9257 100644 --- a/src/rapidata/api_client/api/platform_api.py +++ b/src/rapidata/api_client/api/platform_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/prompt_api.py b/src/rapidata/api_client/api/prompt_api.py index 8d5609e978..21cf4ff0b9 100644 --- a/src/rapidata/api_client/api/prompt_api.py +++ b/src/rapidata/api_client/api/prompt_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/prompt_embedding_map_api.py b/src/rapidata/api_client/api/prompt_embedding_map_api.py index 5eb2bf4e38..7828c32f4f 100644 --- a/src/rapidata/api_client/api/prompt_embedding_map_api.py +++ b/src/rapidata/api_client/api/prompt_embedding_map_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/ranking_flow_api.py b/src/rapidata/api_client/api/ranking_flow_api.py index 65442122bd..2597e8e3ea 100644 --- a/src/rapidata/api_client/api/ranking_flow_api.py +++ b/src/rapidata/api_client/api/ranking_flow_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/ranking_flow_item_api.py b/src/rapidata/api_client/api/ranking_flow_item_api.py index bfee1b4c71..207e48773e 100644 --- a/src/rapidata/api_client/api/ranking_flow_item_api.py +++ b/src/rapidata/api_client/api/ranking_flow_item_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/ranking_workflow_api.py b/src/rapidata/api_client/api/ranking_workflow_api.py deleted file mode 100644 index 1a27805ee2..0000000000 --- a/src/rapidata/api_client/api/ranking_workflow_api.py +++ /dev/null @@ -1,319 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -import warnings -from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt -from typing import Any, Dict, List, Optional, Tuple, Union -from typing_extensions import Annotated - -from pydantic import Field, StrictStr -from typing import Optional -from typing_extensions import Annotated -from rapidata.api_client.models.get_ranking_workflow_results_model import GetRankingWorkflowResultsModel -from rapidata.api_client.models.get_ranking_workflow_results_result import GetRankingWorkflowResultsResult - -from rapidata.api_client.api_client import ApiClient, RequestSerialized -from rapidata.api_client.api_response import ApiResponse -from rapidata.api_client.rest import RESTResponseType - - -class RankingWorkflowApi: - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None) -> None: - if api_client is None: - api_client = ApiClient.get_default() - self.api_client = api_client - - - @validate_call - def workflow_compare_workflow_id_results_get( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[GetRankingWorkflowResultsModel], Field(description="The model for the request.")] = 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, - ) -> GetRankingWorkflowResultsResult: - """Get the result overview for a ranking workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The model for the request. - :type model: GetRankingWorkflowResultsModel - :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._workflow_compare_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetRankingWorkflowResultsResult", - } - 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 workflow_compare_workflow_id_results_get_with_http_info( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[GetRankingWorkflowResultsModel], Field(description="The model for the request.")] = 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[GetRankingWorkflowResultsResult]: - """Get the result overview for a ranking workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The model for the request. - :type model: GetRankingWorkflowResultsModel - :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._workflow_compare_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetRankingWorkflowResultsResult", - } - 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 workflow_compare_workflow_id_results_get_without_preload_content( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - model: Annotated[Optional[GetRankingWorkflowResultsModel], Field(description="The model for the request.")] = 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: - """Get the result overview for a ranking workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param model: The model for the request. - :type model: GetRankingWorkflowResultsModel - :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._workflow_compare_workflow_id_results_get_serialize( - workflow_id=workflow_id, - model=model, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetRankingWorkflowResultsResult", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _workflow_compare_workflow_id_results_get_serialize( - self, - workflow_id, - model, - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if workflow_id is not None: - _path_params['workflowId'] = workflow_id - # process the query parameters - if model is not None: - - _query_params.append(('model', model)) - - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'text/plain', - 'application/json', - 'text/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OAuth2', - 'OpenIdConnect', - 'Bearer' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/workflow/compare/{workflowId}/results', - 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 - ) - - diff --git a/src/rapidata/api_client/api/rapid_api.py b/src/rapidata/api_client/api/rapid_api.py index 05c6fe36ec..c50acc80e4 100644 --- a/src/rapidata/api_client/api/rapid_api.py +++ b/src/rapidata/api_client/api/rapid_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/rapidata_identity_api_api.py b/src/rapidata/api_client/api/rapidata_identity_api_api.py index e69e3487f5..b3b54b9864 100644 --- a/src/rapidata/api_client/api/rapidata_identity_api_api.py +++ b/src/rapidata/api_client/api/rapidata_identity_api_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/reconciliation_api.py b/src/rapidata/api_client/api/reconciliation_api.py index ff20434d2e..1c3f2a0fdd 100644 --- a/src/rapidata/api_client/api/reconciliation_api.py +++ b/src/rapidata/api_client/api/reconciliation_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/replicate_api.py b/src/rapidata/api_client/api/replicate_api.py index 90befb45bd..8320dfc293 100644 --- a/src/rapidata/api_client/api/replicate_api.py +++ b/src/rapidata/api_client/api/replicate_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/sample_api.py b/src/rapidata/api_client/api/sample_api.py index 39e29fad17..ccb63ad5f3 100644 --- a/src/rapidata/api_client/api/sample_api.py +++ b/src/rapidata/api_client/api/sample_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/sample_generation_api.py b/src/rapidata/api_client/api/sample_generation_api.py index e5858858fd..e4494497d2 100644 --- a/src/rapidata/api_client/api/sample_generation_api.py +++ b/src/rapidata/api_client/api/sample_generation_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/settings_api.py b/src/rapidata/api_client/api/settings_api.py index 5a2818794e..849707ef6e 100644 --- a/src/rapidata/api_client/api/settings_api.py +++ b/src/rapidata/api_client/api/settings_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/signal_api.py b/src/rapidata/api_client/api/signal_api.py index e65833e208..60ef9bbea2 100644 --- a/src/rapidata/api_client/api/signal_api.py +++ b/src/rapidata/api_client/api/signal_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/simple_workflow_api.py b/src/rapidata/api_client/api/simple_workflow_api.py deleted file mode 100644 index 0aaddec01e..0000000000 --- a/src/rapidata/api_client/api/simple_workflow_api.py +++ /dev/null @@ -1,376 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.18.1529-c55ad91 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 -import warnings -from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt -from typing import Any, Dict, List, Optional, Tuple, Union -from typing_extensions import Annotated - -from pydantic import Field, StrictInt, StrictStr, field_validator -from typing import List, Optional -from typing_extensions import Annotated -from rapidata.api_client.models.get_simple_workflow_results_endpoint_paged_result_of_output import GetSimpleWorkflowResultsEndpointPagedResultOfOutput -from rapidata.api_client.models.rapid_state import RapidState - -from rapidata.api_client.api_client import ApiClient, RequestSerialized -from rapidata.api_client.api_response import ApiResponse -from rapidata.api_client.rest import RESTResponseType - - -class SimpleWorkflowApi: - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None) -> None: - if api_client is None: - api_client = ApiClient.get_default() - self.api_client = api_client - - - @validate_call - def workflow_simple_workflow_id_results_get( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - states: Annotated[Optional[List[RapidState]], Field(description="Optional list of rapid states to include in the results.")] = None, - page: Annotated[Optional[StrictInt], Field(description="The 1-based page index.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="The number of items per page.")] = None, - sort: Annotated[Optional[List[StrictStr]], Field(description="Sort fields. Prefix with - for descending order (e.g. -created_at).")] = 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, - ) -> GetSimpleWorkflowResultsEndpointPagedResultOfOutput: - """Gets the result overview for a simple workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param states: Optional list of rapid states to include in the results. - :type states: List[RapidState] - :param page: The 1-based page index. - :type page: int - :param page_size: The number of items per page. - :type page_size: int - :param sort: Sort fields. Prefix with - for descending order (e.g. -created_at). - :type sort: List[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._workflow_simple_workflow_id_results_get_serialize( - workflow_id=workflow_id, - states=states, - page=page, - page_size=page_size, - sort=sort, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetSimpleWorkflowResultsEndpointPagedResultOfOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 workflow_simple_workflow_id_results_get_with_http_info( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - states: Annotated[Optional[List[RapidState]], Field(description="Optional list of rapid states to include in the results.")] = None, - page: Annotated[Optional[StrictInt], Field(description="The 1-based page index.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="The number of items per page.")] = None, - sort: Annotated[Optional[List[StrictStr]], Field(description="Sort fields. Prefix with - for descending order (e.g. -created_at).")] = 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[GetSimpleWorkflowResultsEndpointPagedResultOfOutput]: - """Gets the result overview for a simple workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param states: Optional list of rapid states to include in the results. - :type states: List[RapidState] - :param page: The 1-based page index. - :type page: int - :param page_size: The number of items per page. - :type page_size: int - :param sort: Sort fields. Prefix with - for descending order (e.g. -created_at). - :type sort: List[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._workflow_simple_workflow_id_results_get_serialize( - workflow_id=workflow_id, - states=states, - page=page, - page_size=page_size, - sort=sort, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetSimpleWorkflowResultsEndpointPagedResultOfOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 workflow_simple_workflow_id_results_get_without_preload_content( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")], - states: Annotated[Optional[List[RapidState]], Field(description="Optional list of rapid states to include in the results.")] = None, - page: Annotated[Optional[StrictInt], Field(description="The 1-based page index.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="The number of items per page.")] = None, - sort: Annotated[Optional[List[StrictStr]], Field(description="Sort fields. Prefix with - for descending order (e.g. -created_at).")] = 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: - """Gets the result overview for a simple workflow. - - - :param workflow_id: The ID of the workflow to get the results for. (required) - :type workflow_id: str - :param states: Optional list of rapid states to include in the results. - :type states: List[RapidState] - :param page: The 1-based page index. - :type page: int - :param page_size: The number of items per page. - :type page_size: int - :param sort: Sort fields. Prefix with - for descending order (e.g. -created_at). - :type sort: List[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._workflow_simple_workflow_id_results_get_serialize( - workflow_id=workflow_id, - states=states, - page=page, - page_size=page_size, - sort=sort, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetSimpleWorkflowResultsEndpointPagedResultOfOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _workflow_simple_workflow_id_results_get_serialize( - self, - workflow_id, - states, - page, - page_size, - sort, - _request_auth, - _content_type, - _headers, - _host_index, - ) -> RequestSerialized: - - _host = None - - _collection_formats: Dict[str, str] = { - 'states': 'multi', - 'sort': 'multi', - } - - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if workflow_id is not None: - _path_params['workflowId'] = workflow_id - # process the query parameters - if states is not None: - - _query_params.append(('states', states)) - - if page is not None: - - _query_params.append(('page', page)) - - if page_size is not None: - - _query_params.append(('page_size', page_size)) - - if sort is not None: - - _query_params.append(('sort', sort)) - - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OpenIdConnect' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/workflow/simple/{workflowId}/results', - 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 - ) - - diff --git a/src/rapidata/api_client/api/survey_api.py b/src/rapidata/api_client/api/survey_api.py index 5a30189718..8bad828d11 100644 --- a/src/rapidata/api_client/api/survey_api.py +++ b/src/rapidata/api_client/api/survey_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/translation_api.py b/src/rapidata/api_client/api/translation_api.py index 0b0c1f79d3..87c23d56c5 100644 --- a/src/rapidata/api_client/api/translation_api.py +++ b/src/rapidata/api_client/api/translation_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/user_rapid_api.py b/src/rapidata/api_client/api/user_rapid_api.py index c5fd8c1bf7..0a65a7fa15 100644 --- a/src/rapidata/api_client/api/user_rapid_api.py +++ b/src/rapidata/api_client/api/user_rapid_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/validation_feedback_api.py b/src/rapidata/api_client/api/validation_feedback_api.py index fa7457ed84..a3978ffbf7 100644 --- a/src/rapidata/api_client/api/validation_feedback_api.py +++ b/src/rapidata/api_client/api/validation_feedback_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/validation_set_api.py b/src/rapidata/api_client/api/validation_set_api.py index 6bb4392187..a6d24ee75e 100644 --- a/src/rapidata/api_client/api/validation_set_api.py +++ b/src/rapidata/api_client/api/validation_set_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/volume_discount_api.py b/src/rapidata/api_client/api/volume_discount_api.py index 107f44911a..8169d9062b 100644 --- a/src/rapidata/api_client/api/volume_discount_api.py +++ b/src/rapidata/api_client/api/volume_discount_api.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/api/workflow_api.py b/src/rapidata/api_client/api/workflow_api.py deleted file mode 100644 index f283472024..0000000000 --- a/src/rapidata/api_client/api/workflow_api.py +++ /dev/null @@ -1,1010 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 -import warnings -from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt -from typing import Any, Dict, List, Optional, Tuple, Union -from typing_extensions import Annotated - -from pydantic import Field, StrictInt, StrictStr, field_validator -from typing import List, Optional -from typing_extensions import Annotated -from rapidata.api_client.models.audience_audience_id_jobs_get_job_id_parameter import AudienceAudienceIdJobsGetJobIdParameter -from rapidata.api_client.models.get_workflow_progress_endpoint_output import GetWorkflowProgressEndpointOutput -from rapidata.api_client.models.query_workflows_endpoint_paged_result_of_output import QueryWorkflowsEndpointPagedResultOfOutput - -from rapidata.api_client.api_client import ApiClient, RequestSerialized -from rapidata.api_client.api_response import ApiResponse -from rapidata.api_client.rest import RESTResponseType - - -class WorkflowApi: - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None) -> None: - if api_client is None: - api_client = ApiClient.get_default() - self.api_client = api_client - - - @validate_call - def workflow_workflow_id_delete( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to delete.")], - _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, - ) -> None: - """Deletes a workflow by its id. - - - :param workflow_id: The ID of the workflow to delete. (required) - :type workflow_id: 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._workflow_workflow_id_delete_serialize( - workflow_id=workflow_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '204': None, - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 workflow_workflow_id_delete_with_http_info( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to delete.")], - _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[None]: - """Deletes a workflow by its id. - - - :param workflow_id: The ID of the workflow to delete. (required) - :type workflow_id: 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._workflow_workflow_id_delete_serialize( - workflow_id=workflow_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '204': None, - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 workflow_workflow_id_delete_without_preload_content( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to delete.")], - _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: - """Deletes a workflow by its id. - - - :param workflow_id: The ID of the workflow to delete. (required) - :type workflow_id: 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._workflow_workflow_id_delete_serialize( - workflow_id=workflow_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '204': None, - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _workflow_workflow_id_delete_serialize( - self, - workflow_id, - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if workflow_id is not None: - _path_params['workflowId'] = workflow_id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OpenIdConnect' - ] - - return self.api_client.param_serialize( - method='DELETE', - resource_path='/workflow/{workflowId}', - 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 workflow_workflow_id_progress_get( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the progress for.")], - _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, - ) -> GetWorkflowProgressEndpointOutput: - """(Deprecated) Gets the progress of a workflow. - - - :param workflow_id: The ID of the workflow to get the progress for. (required) - :type workflow_id: 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 - warnings.warn("GET /workflow/{workflowId}/progress is deprecated.", DeprecationWarning) - - _param = self._workflow_workflow_id_progress_get_serialize( - workflow_id=workflow_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetWorkflowProgressEndpointOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 workflow_workflow_id_progress_get_with_http_info( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the progress for.")], - _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[GetWorkflowProgressEndpointOutput]: - """(Deprecated) Gets the progress of a workflow. - - - :param workflow_id: The ID of the workflow to get the progress for. (required) - :type workflow_id: 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 - warnings.warn("GET /workflow/{workflowId}/progress is deprecated.", DeprecationWarning) - - _param = self._workflow_workflow_id_progress_get_serialize( - workflow_id=workflow_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetWorkflowProgressEndpointOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 workflow_workflow_id_progress_get_without_preload_content( - self, - workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the progress for.")], - _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: - """(Deprecated) Gets the progress of a workflow. - - - :param workflow_id: The ID of the workflow to get the progress for. (required) - :type workflow_id: 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 - warnings.warn("GET /workflow/{workflowId}/progress is deprecated.", DeprecationWarning) - - _param = self._workflow_workflow_id_progress_get_serialize( - workflow_id=workflow_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetWorkflowProgressEndpointOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _workflow_workflow_id_progress_get_serialize( - self, - workflow_id, - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if workflow_id is not None: - _path_params['workflowId'] = workflow_id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OpenIdConnect' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/workflow/{workflowId}/progress', - 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 workflows_get( - self, - page: Annotated[Optional[StrictInt], Field(description="The 1-based page index.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="The number of items per page.")] = None, - sort: Annotated[Optional[List[StrictStr]], Field(description="Sort fields. Prefix with - for descending order (e.g. -created_at).")] = None, - id: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by id.")] = None, - name: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by name.")] = None, - state: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by state.")] = None, - owner_mail: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by owner_mail.")] = None, - logic: Annotated[Optional[StrictStr], Field(description="How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.")] = 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, - ) -> QueryWorkflowsEndpointPagedResultOfOutput: - """Queries workflows based on the provided filter, page, and sort criteria. - - - :param page: The 1-based page index. - :type page: int - :param page_size: The number of items per page. - :type page_size: int - :param sort: Sort fields. Prefix with - for descending order (e.g. -created_at). - :type sort: List[str] - :param id: Filter by id. - :type id: AudienceAudienceIdJobsGetJobIdParameter - :param name: Filter by name. - :type name: AudienceAudienceIdJobsGetJobIdParameter - :param state: Filter by state. - :type state: AudienceAudienceIdJobsGetJobIdParameter - :param owner_mail: Filter by owner_mail. - :type owner_mail: AudienceAudienceIdJobsGetJobIdParameter - :param logic: How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match. - :type logic: 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._workflows_get_serialize( - page=page, - page_size=page_size, - sort=sort, - id=id, - name=name, - state=state, - owner_mail=owner_mail, - logic=logic, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "QueryWorkflowsEndpointPagedResultOfOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 workflows_get_with_http_info( - self, - page: Annotated[Optional[StrictInt], Field(description="The 1-based page index.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="The number of items per page.")] = None, - sort: Annotated[Optional[List[StrictStr]], Field(description="Sort fields. Prefix with - for descending order (e.g. -created_at).")] = None, - id: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by id.")] = None, - name: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by name.")] = None, - state: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by state.")] = None, - owner_mail: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by owner_mail.")] = None, - logic: Annotated[Optional[StrictStr], Field(description="How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.")] = 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[QueryWorkflowsEndpointPagedResultOfOutput]: - """Queries workflows based on the provided filter, page, and sort criteria. - - - :param page: The 1-based page index. - :type page: int - :param page_size: The number of items per page. - :type page_size: int - :param sort: Sort fields. Prefix with - for descending order (e.g. -created_at). - :type sort: List[str] - :param id: Filter by id. - :type id: AudienceAudienceIdJobsGetJobIdParameter - :param name: Filter by name. - :type name: AudienceAudienceIdJobsGetJobIdParameter - :param state: Filter by state. - :type state: AudienceAudienceIdJobsGetJobIdParameter - :param owner_mail: Filter by owner_mail. - :type owner_mail: AudienceAudienceIdJobsGetJobIdParameter - :param logic: How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match. - :type logic: 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._workflows_get_serialize( - page=page, - page_size=page_size, - sort=sort, - id=id, - name=name, - state=state, - owner_mail=owner_mail, - logic=logic, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "QueryWorkflowsEndpointPagedResultOfOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - 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 workflows_get_without_preload_content( - self, - page: Annotated[Optional[StrictInt], Field(description="The 1-based page index.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="The number of items per page.")] = None, - sort: Annotated[Optional[List[StrictStr]], Field(description="Sort fields. Prefix with - for descending order (e.g. -created_at).")] = None, - id: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by id.")] = None, - name: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by name.")] = None, - state: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by state.")] = None, - owner_mail: Annotated[Optional[AudienceAudienceIdJobsGetJobIdParameter], Field(description="Filter by owner_mail.")] = None, - logic: Annotated[Optional[StrictStr], Field(description="How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match.")] = 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: - """Queries workflows based on the provided filter, page, and sort criteria. - - - :param page: The 1-based page index. - :type page: int - :param page_size: The number of items per page. - :type page_size: int - :param sort: Sort fields. Prefix with - for descending order (e.g. -created_at). - :type sort: List[str] - :param id: Filter by id. - :type id: AudienceAudienceIdJobsGetJobIdParameter - :param name: Filter by name. - :type name: AudienceAudienceIdJobsGetJobIdParameter - :param state: Filter by state. - :type state: AudienceAudienceIdJobsGetJobIdParameter - :param owner_mail: Filter by owner_mail. - :type owner_mail: AudienceAudienceIdJobsGetJobIdParameter - :param logic: How to combine the field filters: \"and\" (default) requires every filter to match, \"or\" requires any of them to match. - :type logic: 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._workflows_get_serialize( - page=page, - page_size=page_size, - sort=sort, - id=id, - name=name, - state=state, - owner_mail=owner_mail, - logic=logic, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "QueryWorkflowsEndpointPagedResultOfOutput", - '400': "ValidationProblemDetails", - '401': None, - '403': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _workflows_get_serialize( - self, - page, - page_size, - sort, - id, - name, - state, - owner_mail, - logic, - _request_auth, - _content_type, - _headers, - _host_index, - ) -> RequestSerialized: - - _host = None - - _collection_formats: Dict[str, str] = { - 'sort': 'multi', - } - - _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, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - # process the query parameters - if page is not None: - - _query_params.append(('page', page)) - - if page_size is not None: - - _query_params.append(('page_size', page_size)) - - if sort is not None: - - _query_params.append(('sort', sort)) - - if id is not None: - _param_val = id - if hasattr(_param_val, 'to_dict'): - _param_val = _param_val.to_dict() - if isinstance(_param_val, dict): - for _k, _v in _param_val.items(): - if _v is None: - continue - if isinstance(_v, list): - # Explode list operator values (e.g. `in`) into repeated - # params: field[in]=a&field[in]=b. - for _item in _v: - _query_params.append(('id[' + _k + ']', _item)) - else: - _query_params.append(('id[' + _k + ']', _v)) - if name is not None: - _param_val = name - if hasattr(_param_val, 'to_dict'): - _param_val = _param_val.to_dict() - if isinstance(_param_val, dict): - for _k, _v in _param_val.items(): - if _v is None: - continue - if isinstance(_v, list): - # Explode list operator values (e.g. `in`) into repeated - # params: field[in]=a&field[in]=b. - for _item in _v: - _query_params.append(('name[' + _k + ']', _item)) - else: - _query_params.append(('name[' + _k + ']', _v)) - if state is not None: - _param_val = state - if hasattr(_param_val, 'to_dict'): - _param_val = _param_val.to_dict() - if isinstance(_param_val, dict): - for _k, _v in _param_val.items(): - if _v is None: - continue - if isinstance(_v, list): - # Explode list operator values (e.g. `in`) into repeated - # params: field[in]=a&field[in]=b. - for _item in _v: - _query_params.append(('state[' + _k + ']', _item)) - else: - _query_params.append(('state[' + _k + ']', _v)) - if owner_mail is not None: - _param_val = owner_mail - if hasattr(_param_val, 'to_dict'): - _param_val = _param_val.to_dict() - if isinstance(_param_val, dict): - for _k, _v in _param_val.items(): - if _v is None: - continue - if isinstance(_v, list): - # Explode list operator values (e.g. `in`) into repeated - # params: field[in]=a&field[in]=b. - for _item in _v: - _query_params.append(('owner_mail[' + _k + ']', _item)) - else: - _query_params.append(('owner_mail[' + _k + ']', _v)) - if logic is not None: - - _query_params.append(('logic', logic)) - - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - 'OpenIdConnect' - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/workflows', - 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 - ) - - diff --git a/src/rapidata/api_client/api_client.py b/src/rapidata/api_client/api_client.py index 072e28a65b..2f97abf48f 100644 --- a/src/rapidata/api_client/api_client.py +++ b/src/rapidata/api_client/api_client.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/configuration.py b/src/rapidata/api_client/configuration.py index 0f95b0d6f3..22ff4b46f4 100644 --- a/src/rapidata/api_client/configuration.py +++ b/src/rapidata/api_client/configuration.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. @@ -383,7 +383,7 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 2026.08.20.1843-f4aff59\n"\ + "Version of the API: 2026.08.21.0757-4bc4250\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/src/rapidata/api_client/exceptions.py b/src/rapidata/api_client/exceptions.py index 36cfe7eb06..82444a6aac 100644 --- a/src/rapidata/api_client/exceptions.py +++ b/src/rapidata/api_client/exceptions.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/__init__.py b/src/rapidata/api_client/models/__init__.py index 40035504e9..6e00eb4f4d 100644 --- a/src/rapidata/api_client/models/__init__.py +++ b/src/rapidata/api_client/models/__init__.py @@ -6,7 +6,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/accept_org_invitation_endpoint_input.py b/src/rapidata/api_client/models/accept_org_invitation_endpoint_input.py index d513aae912..f8743c2757 100644 --- a/src/rapidata/api_client/models/accept_org_invitation_endpoint_input.py +++ b/src/rapidata/api_client/models/accept_org_invitation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/accept_org_invitation_endpoint_output.py b/src/rapidata/api_client/models/accept_org_invitation_endpoint_output.py index 9bd1547923..93fd470775 100644 --- a/src/rapidata/api_client/models/accept_org_invitation_endpoint_output.py +++ b/src/rapidata/api_client/models/accept_org_invitation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/add_example_to_audience_endpoint_input.py b/src/rapidata/api_client/models/add_example_to_audience_endpoint_input.py index 68d3b301a0..7b6e86ad3f 100644 --- a/src/rapidata/api_client/models/add_example_to_audience_endpoint_input.py +++ b/src/rapidata/api_client/models/add_example_to_audience_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/add_example_to_audience_endpoint_output.py b/src/rapidata/api_client/models/add_example_to_audience_endpoint_output.py index cad5645271..18535a10df 100644 --- a/src/rapidata/api_client/models/add_example_to_audience_endpoint_output.py +++ b/src/rapidata/api_client/models/add_example_to_audience_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/add_user_response_endpoint_input.py b/src/rapidata/api_client/models/add_user_response_endpoint_input.py index 9b1b3c9adc..582dc00374 100644 --- a/src/rapidata/api_client/models/add_user_response_endpoint_input.py +++ b/src/rapidata/api_client/models/add_user_response_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/add_user_response_endpoint_output.py b/src/rapidata/api_client/models/add_user_response_endpoint_output.py index d80930c91c..cc37dab886 100644 --- a/src/rapidata/api_client/models/add_user_response_endpoint_output.py +++ b/src/rapidata/api_client/models/add_user_response_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/add_validation_rapid_endpoint_input.py b/src/rapidata/api_client/models/add_validation_rapid_endpoint_input.py index 56af354c1c..9b23ca047f 100644 --- a/src/rapidata/api_client/models/add_validation_rapid_endpoint_input.py +++ b/src/rapidata/api_client/models/add_validation_rapid_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/age_user_filter_age_group.py b/src/rapidata/api_client/models/age_user_filter_age_group.py index d04f4f66c8..97ee4ce0a5 100644 --- a/src/rapidata/api_client/models/age_user_filter_age_group.py +++ b/src/rapidata/api_client/models/age_user_filter_age_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/aggregator_type.py b/src/rapidata/api_client/models/aggregator_type.py index e36ad63908..cac51b47c3 100644 --- a/src/rapidata/api_client/models/aggregator_type.py +++ b/src/rapidata/api_client/models/aggregator_type.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/attach_category_rapid_blueprint_category.py b/src/rapidata/api_client/models/attach_category_rapid_blueprint_category.py index c224f75e88..1852b3ed6d 100644 --- a/src/rapidata/api_client/models/attach_category_rapid_blueprint_category.py +++ b/src/rapidata/api_client/models/attach_category_rapid_blueprint_category.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/attach_category_rapid_category.py b/src/rapidata/api_client/models/attach_category_rapid_category.py index 8dc0b1863c..1d3b040f6b 100644 --- a/src/rapidata/api_client/models/attach_category_rapid_category.py +++ b/src/rapidata/api_client/models/attach_category_rapid_category.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/attach_category_workflow_rapid_blueprint_category.py b/src/rapidata/api_client/models/attach_category_workflow_rapid_blueprint_category.py deleted file mode 100644 index 6691391829..0000000000 --- a/src/rapidata/api_client/models/attach_category_workflow_rapid_blueprint_category.py +++ /dev/null @@ -1,90 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class AttachCategoryWorkflowRapidBlueprintCategory(LazyValidatedModel): - """ - AttachCategoryWorkflowRapidBlueprintCategory - """ # noqa: E501 - label: StrictStr - value: StrictStr - __properties: ClassVar[List[str]] = ["label", "value"] - - # model_config is inherited from LazyValidatedModel - - - 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 AttachCategoryWorkflowRapidBlueprintCategory 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 AttachCategoryWorkflowRapidBlueprintCategory from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "label": obj.get("label"), - "value": obj.get("value") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/audience_audience_id_jobs_get_job_id_parameter.py b/src/rapidata/api_client/models/audience_audience_id_jobs_get_job_id_parameter.py index 2b5cf5dd2a..54abdee2a6 100644 --- a/src/rapidata/api_client/models/audience_audience_id_jobs_get_job_id_parameter.py +++ b/src/rapidata/api_client/models/audience_audience_id_jobs_get_job_id_parameter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/audience_boost.py b/src/rapidata/api_client/models/audience_boost.py index 38f2125053..93e2a846fa 100644 --- a/src/rapidata/api_client/models/audience_boost.py +++ b/src/rapidata/api_client/models/audience_boost.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/audience_boost2.py b/src/rapidata/api_client/models/audience_boost2.py index 6186af6303..f08eeeca71 100644 --- a/src/rapidata/api_client/models/audience_boost2.py +++ b/src/rapidata/api_client/models/audience_boost2.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/audience_inactivity_sync_phase.py b/src/rapidata/api_client/models/audience_inactivity_sync_phase.py index 4eaec15546..da9ba87fb0 100644 --- a/src/rapidata/api_client/models/audience_inactivity_sync_phase.py +++ b/src/rapidata/api_client/models/audience_inactivity_sync_phase.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/audience_inactivity_sync_state.py b/src/rapidata/api_client/models/audience_inactivity_sync_state.py index a2c805c48e..72a84f3cdf 100644 --- a/src/rapidata/api_client/models/audience_inactivity_sync_state.py +++ b/src/rapidata/api_client/models/audience_inactivity_sync_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/audience_job_state.py b/src/rapidata/api_client/models/audience_job_state.py index 1009ce88f0..b44b4c4bac 100644 --- a/src/rapidata/api_client/models/audience_job_state.py +++ b/src/rapidata/api_client/models/audience_job_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/audience_state_recalculation_phase.py b/src/rapidata/api_client/models/audience_state_recalculation_phase.py index 2416cfe49f..53b66325fe 100644 --- a/src/rapidata/api_client/models/audience_state_recalculation_phase.py +++ b/src/rapidata/api_client/models/audience_state_recalculation_phase.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/audience_state_recalculation_state.py b/src/rapidata/api_client/models/audience_state_recalculation_state.py index e77c5dff2e..416ccae49b 100644 --- a/src/rapidata/api_client/models/audience_state_recalculation_state.py +++ b/src/rapidata/api_client/models/audience_state_recalculation_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/audience_status.py b/src/rapidata/api_client/models/audience_status.py index 3793041cf0..8ef0affdf7 100644 --- a/src/rapidata/api_client/models/audience_status.py +++ b/src/rapidata/api_client/models/audience_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/authorization_relations_bidder.py b/src/rapidata/api_client/models/authorization_relations_bidder.py index e02e423781..90b69abdb3 100644 --- a/src/rapidata/api_client/models/authorization_relations_bidder.py +++ b/src/rapidata/api_client/models/authorization_relations_bidder.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/authorization_relations_external_app.py b/src/rapidata/api_client/models/authorization_relations_external_app.py index 42207c63e7..558d1c432a 100644 --- a/src/rapidata/api_client/models/authorization_relations_external_app.py +++ b/src/rapidata/api_client/models/authorization_relations_external_app.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/authorization_relations_platform.py b/src/rapidata/api_client/models/authorization_relations_platform.py index 49cf749efa..0cadd92e91 100644 --- a/src/rapidata/api_client/models/authorization_relations_platform.py +++ b/src/rapidata/api_client/models/authorization_relations_platform.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/authorization_scope.py b/src/rapidata/api_client/models/authorization_scope.py index f6e5f61742..6d116c7500 100644 --- a/src/rapidata/api_client/models/authorization_scope.py +++ b/src/rapidata/api_client/models/authorization_scope.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/batch_upload_status.py b/src/rapidata/api_client/models/batch_upload_status.py index f2eb521af3..1ffc150532 100644 --- a/src/rapidata/api_client/models/batch_upload_status.py +++ b/src/rapidata/api_client/models/batch_upload_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/batch_upload_url_status.py b/src/rapidata/api_client/models/batch_upload_url_status.py index 016e156e49..3b616be2e1 100644 --- a/src/rapidata/api_client/models/batch_upload_url_status.py +++ b/src/rapidata/api_client/models/batch_upload_url_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/benchmark_demographic_dimension.py b/src/rapidata/api_client/models/benchmark_demographic_dimension.py index b737a569d5..e98a7906b9 100644 --- a/src/rapidata/api_client/models/benchmark_demographic_dimension.py +++ b/src/rapidata/api_client/models/benchmark_demographic_dimension.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/billing_period_status.py b/src/rapidata/api_client/models/billing_period_status.py index c9cb837bbe..44fb5389ed 100644 --- a/src/rapidata/api_client/models/billing_period_status.py +++ b/src/rapidata/api_client/models/billing_period_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/billing_summary_mode.py b/src/rapidata/api_client/models/billing_summary_mode.py index 29975dd13a..9731fbcac5 100644 --- a/src/rapidata/api_client/models/billing_summary_mode.py +++ b/src/rapidata/api_client/models/billing_summary_mode.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/boost_leaderboard_endpoint_input.py b/src/rapidata/api_client/models/boost_leaderboard_endpoint_input.py index 24b711d975..9bac97319b 100644 --- a/src/rapidata/api_client/models/boost_leaderboard_endpoint_input.py +++ b/src/rapidata/api_client/models/boost_leaderboard_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/boost_level.py b/src/rapidata/api_client/models/boost_level.py index 904b7266c8..3f54381b3f 100644 --- a/src/rapidata/api_client/models/boost_level.py +++ b/src/rapidata/api_client/models/boost_level.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/boost_mode.py b/src/rapidata/api_client/models/boost_mode.py index d38a056230..b0937e0bb9 100644 --- a/src/rapidata/api_client/models/boost_mode.py +++ b/src/rapidata/api_client/models/boost_mode.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/boost_status.py b/src/rapidata/api_client/models/boost_status.py index a58a6e0a5a..8cd5088b9a 100644 --- a/src/rapidata/api_client/models/boost_status.py +++ b/src/rapidata/api_client/models/boost_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/boosting_control_mode.py b/src/rapidata/api_client/models/boosting_control_mode.py index b72f5fcfff..f519436fea 100644 --- a/src/rapidata/api_client/models/boosting_control_mode.py +++ b/src/rapidata/api_client/models/boosting_control_mode.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/boosting_profile.py b/src/rapidata/api_client/models/boosting_profile.py index a2736d9bdb..7c99d18466 100644 --- a/src/rapidata/api_client/models/boosting_profile.py +++ b/src/rapidata/api_client/models/boosting_profile.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/bounding_box_result_box.py b/src/rapidata/api_client/models/bounding_box_result_box.py index d2814599ad..a9f36fc629 100644 --- a/src/rapidata/api_client/models/bounding_box_result_box.py +++ b/src/rapidata/api_client/models/bounding_box_result_box.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/bulk_billing_period_close_state.py b/src/rapidata/api_client/models/bulk_billing_period_close_state.py index 15f110f61c..61515e8afd 100644 --- a/src/rapidata/api_client/models/bulk_billing_period_close_state.py +++ b/src/rapidata/api_client/models/bulk_billing_period_close_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/bulk_close_billing_periods_endpoint_input.py b/src/rapidata/api_client/models/bulk_close_billing_periods_endpoint_input.py index 0334f035d5..91629eb8ac 100644 --- a/src/rapidata/api_client/models/bulk_close_billing_periods_endpoint_input.py +++ b/src/rapidata/api_client/models/bulk_close_billing_periods_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/bulk_close_billing_periods_endpoint_output.py b/src/rapidata/api_client/models/bulk_close_billing_periods_endpoint_output.py index 343a0d5f28..bfa39d67a3 100644 --- a/src/rapidata/api_client/models/bulk_close_billing_periods_endpoint_output.py +++ b/src/rapidata/api_client/models/bulk_close_billing_periods_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/bulk_reconciliation_dispatch_state.py b/src/rapidata/api_client/models/bulk_reconciliation_dispatch_state.py index 5fcbf15f6e..c835daed3c 100644 --- a/src/rapidata/api_client/models/bulk_reconciliation_dispatch_state.py +++ b/src/rapidata/api_client/models/bulk_reconciliation_dispatch_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/campaign_status.py b/src/rapidata/api_client/models/campaign_status.py index 4c3b69bdc3..2c90635fe2 100644 --- a/src/rapidata/api_client/models/campaign_status.py +++ b/src/rapidata/api_client/models/campaign_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/capability.py b/src/rapidata/api_client/models/capability.py index 849a9d19de..f4d93d69a7 100644 --- a/src/rapidata/api_client/models/capability.py +++ b/src/rapidata/api_client/models/capability.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/change_audience_owner_endpoint_input.py b/src/rapidata/api_client/models/change_audience_owner_endpoint_input.py index a66903c373..a9776f0dfe 100644 --- a/src/rapidata/api_client/models/change_audience_owner_endpoint_input.py +++ b/src/rapidata/api_client/models/change_audience_owner_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/change_boost_endpoint_input.py b/src/rapidata/api_client/models/change_boost_endpoint_input.py index 8cc38c71e3..c56817dbcc 100644 --- a/src/rapidata/api_client/models/change_boost_endpoint_input.py +++ b/src/rapidata/api_client/models/change_boost_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/change_org_member_role_endpoint_input.py b/src/rapidata/api_client/models/change_org_member_role_endpoint_input.py index b530ea84e6..3f8b32097a 100644 --- a/src/rapidata/api_client/models/change_org_member_role_endpoint_input.py +++ b/src/rapidata/api_client/models/change_org_member_role_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/classify_payload.py b/src/rapidata/api_client/models/classify_payload.py index fccbe7b74f..7252d60905 100644 --- a/src/rapidata/api_client/models/classify_payload.py +++ b/src/rapidata/api_client/models/classify_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/classify_payload_category.py b/src/rapidata/api_client/models/classify_payload_category.py index 15c286acd4..fd6bacfa00 100644 --- a/src/rapidata/api_client/models/classify_payload_category.py +++ b/src/rapidata/api_client/models/classify_payload_category.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/client.py b/src/rapidata/api_client/models/client.py index 74339b9bcb..70cfecf018 100644 --- a/src/rapidata/api_client/models/client.py +++ b/src/rapidata/api_client/models/client.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/clone_job_definition_endpoint_input.py b/src/rapidata/api_client/models/clone_job_definition_endpoint_input.py index 271f1f0adf..6df55bbcf7 100644 --- a/src/rapidata/api_client/models/clone_job_definition_endpoint_input.py +++ b/src/rapidata/api_client/models/clone_job_definition_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/clone_job_definition_endpoint_output.py b/src/rapidata/api_client/models/clone_job_definition_endpoint_output.py index 4e983c9742..9d75f27d46 100644 --- a/src/rapidata/api_client/models/clone_job_definition_endpoint_output.py +++ b/src/rapidata/api_client/models/clone_job_definition_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/clone_order_endpoint_input.py b/src/rapidata/api_client/models/clone_order_endpoint_input.py index ebf1cd61db..a05b358a64 100644 --- a/src/rapidata/api_client/models/clone_order_endpoint_input.py +++ b/src/rapidata/api_client/models/clone_order_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/clone_order_endpoint_output.py b/src/rapidata/api_client/models/clone_order_endpoint_output.py index 56dca675a9..ef90753152 100644 --- a/src/rapidata/api_client/models/clone_order_endpoint_output.py +++ b/src/rapidata/api_client/models/clone_order_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/close_billing_period_endpoint_input.py b/src/rapidata/api_client/models/close_billing_period_endpoint_input.py index 331d01d5d5..9c62091a0a 100644 --- a/src/rapidata/api_client/models/close_billing_period_endpoint_input.py +++ b/src/rapidata/api_client/models/close_billing_period_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/close_billing_period_endpoint_output.py b/src/rapidata/api_client/models/close_billing_period_endpoint_output.py index d2743d6055..3e45bd8844 100644 --- a/src/rapidata/api_client/models/close_billing_period_endpoint_output.py +++ b/src/rapidata/api_client/models/close_billing_period_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/comparison_operator.py b/src/rapidata/api_client/models/comparison_operator.py index 9b547020e3..c9b94a2662 100644 --- a/src/rapidata/api_client/models/comparison_operator.py +++ b/src/rapidata/api_client/models/comparison_operator.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/compression_override.py b/src/rapidata/api_client/models/compression_override.py index 0c546f8ed9..bb0a078880 100644 --- a/src/rapidata/api_client/models/compression_override.py +++ b/src/rapidata/api_client/models/compression_override.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/conditional_validation_selection_validation_chance.py b/src/rapidata/api_client/models/conditional_validation_selection_validation_chance.py index 99d1ef0a94..f0d207c734 100644 --- a/src/rapidata/api_client/models/conditional_validation_selection_validation_chance.py +++ b/src/rapidata/api_client/models/conditional_validation_selection_validation_chance.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/confidence_interval.py b/src/rapidata/api_client/models/confidence_interval.py index 291f020a7f..8a5deddd92 100644 --- a/src/rapidata/api_client/models/confidence_interval.py +++ b/src/rapidata/api_client/models/confidence_interval.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_audience_endpoint_input.py b/src/rapidata/api_client/models/create_audience_endpoint_input.py index 4034fd2548..11899ca293 100644 --- a/src/rapidata/api_client/models/create_audience_endpoint_input.py +++ b/src/rapidata/api_client/models/create_audience_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_audience_endpoint_output.py b/src/rapidata/api_client/models/create_audience_endpoint_output.py index 7a19ef052e..0d2b1fa5a9 100644 --- a/src/rapidata/api_client/models/create_audience_endpoint_output.py +++ b/src/rapidata/api_client/models/create_audience_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_batch_upload_endpoint_input.py b/src/rapidata/api_client/models/create_batch_upload_endpoint_input.py index d6ace60d1a..baf772c7aa 100644 --- a/src/rapidata/api_client/models/create_batch_upload_endpoint_input.py +++ b/src/rapidata/api_client/models/create_batch_upload_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_batch_upload_endpoint_output.py b/src/rapidata/api_client/models/create_batch_upload_endpoint_output.py index 32c1716fb5..2d625f1729 100644 --- a/src/rapidata/api_client/models/create_batch_upload_endpoint_output.py +++ b/src/rapidata/api_client/models/create_batch_upload_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_benchmark_endpoint_input.py b/src/rapidata/api_client/models/create_benchmark_endpoint_input.py index 47b8226baf..550f75b8d7 100644 --- a/src/rapidata/api_client/models/create_benchmark_endpoint_input.py +++ b/src/rapidata/api_client/models/create_benchmark_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_benchmark_endpoint_output.py b/src/rapidata/api_client/models/create_benchmark_endpoint_output.py index a8a2e6fc35..aa105da0cf 100644 --- a/src/rapidata/api_client/models/create_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/create_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_benchmark_participant_endpoint_input.py b/src/rapidata/api_client/models/create_benchmark_participant_endpoint_input.py index ad63022f56..df15f28e11 100644 --- a/src/rapidata/api_client/models/create_benchmark_participant_endpoint_input.py +++ b/src/rapidata/api_client/models/create_benchmark_participant_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_benchmark_participant_endpoint_output.py b/src/rapidata/api_client/models/create_benchmark_participant_endpoint_output.py index 942f152d7e..e12cacbd6d 100644 --- a/src/rapidata/api_client/models/create_benchmark_participant_endpoint_output.py +++ b/src/rapidata/api_client/models/create_benchmark_participant_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_billing_item_billing_setting_endpoint_input.py b/src/rapidata/api_client/models/create_billing_item_billing_setting_endpoint_input.py index 7253ab1a78..1340acc3dd 100644 --- a/src/rapidata/api_client/models/create_billing_item_billing_setting_endpoint_input.py +++ b/src/rapidata/api_client/models/create_billing_item_billing_setting_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_bridge_token_endpoint_output.py b/src/rapidata/api_client/models/create_bridge_token_endpoint_output.py index ce237684d7..10d37c52c4 100644 --- a/src/rapidata/api_client/models/create_bridge_token_endpoint_output.py +++ b/src/rapidata/api_client/models/create_bridge_token_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_checkout_endpoint_output.py b/src/rapidata/api_client/models/create_checkout_endpoint_output.py index 999ae7ac54..2b78f90825 100644 --- a/src/rapidata/api_client/models/create_checkout_endpoint_output.py +++ b/src/rapidata/api_client/models/create_checkout_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_client_endpoint_input.py b/src/rapidata/api_client/models/create_client_endpoint_input.py index 65fb17e440..cf475aff02 100644 --- a/src/rapidata/api_client/models/create_client_endpoint_input.py +++ b/src/rapidata/api_client/models/create_client_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_client_endpoint_output.py b/src/rapidata/api_client/models/create_client_endpoint_output.py index f786cd0b2e..9b6f3c89d0 100644 --- a/src/rapidata/api_client/models/create_client_endpoint_output.py +++ b/src/rapidata/api_client/models/create_client_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_complex_order_endpoint_input.py b/src/rapidata/api_client/models/create_complex_order_endpoint_input.py index f12959a7d6..6f37f06915 100644 --- a/src/rapidata/api_client/models/create_complex_order_endpoint_input.py +++ b/src/rapidata/api_client/models/create_complex_order_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_complex_order_endpoint_output.py b/src/rapidata/api_client/models/create_complex_order_endpoint_output.py index 9f8e1fc132..d6938879c3 100644 --- a/src/rapidata/api_client/models/create_complex_order_endpoint_output.py +++ b/src/rapidata/api_client/models/create_complex_order_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_datapoint_endpoint_input.py b/src/rapidata/api_client/models/create_datapoint_endpoint_input.py index 8bd081e94d..9abcaa2b95 100644 --- a/src/rapidata/api_client/models/create_datapoint_endpoint_input.py +++ b/src/rapidata/api_client/models/create_datapoint_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_datapoint_endpoint_output.py b/src/rapidata/api_client/models/create_datapoint_endpoint_output.py index 245bdefb82..14f6456948 100644 --- a/src/rapidata/api_client/models/create_datapoint_endpoint_output.py +++ b/src/rapidata/api_client/models/create_datapoint_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_dataset_endpoint_input.py b/src/rapidata/api_client/models/create_dataset_endpoint_input.py index 15b79a57f2..b6f12d4788 100644 --- a/src/rapidata/api_client/models/create_dataset_endpoint_input.py +++ b/src/rapidata/api_client/models/create_dataset_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_dataset_endpoint_output.py b/src/rapidata/api_client/models/create_dataset_endpoint_output.py index 96c07ec32b..9598db0ea0 100644 --- a/src/rapidata/api_client/models/create_dataset_endpoint_output.py +++ b/src/rapidata/api_client/models/create_dataset_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_dataset_group_endpoint_input.py b/src/rapidata/api_client/models/create_dataset_group_endpoint_input.py index 4b12d2fe89..36cd1e31fd 100644 --- a/src/rapidata/api_client/models/create_dataset_group_endpoint_input.py +++ b/src/rapidata/api_client/models/create_dataset_group_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_demographic_rapid_endpoint_input.py b/src/rapidata/api_client/models/create_demographic_rapid_endpoint_input.py index f9716fd08e..7cc6945370 100644 --- a/src/rapidata/api_client/models/create_demographic_rapid_endpoint_input.py +++ b/src/rapidata/api_client/models/create_demographic_rapid_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_demographic_rapid_endpoint_output.py b/src/rapidata/api_client/models/create_demographic_rapid_endpoint_output.py index cc0caadcbb..2f87f2e59f 100644 --- a/src/rapidata/api_client/models/create_demographic_rapid_endpoint_output.py +++ b/src/rapidata/api_client/models/create_demographic_rapid_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_external_service_price_endpoint_input.py b/src/rapidata/api_client/models/create_external_service_price_endpoint_input.py index 018dd75ab2..1f4f4bc3a6 100644 --- a/src/rapidata/api_client/models/create_external_service_price_endpoint_input.py +++ b/src/rapidata/api_client/models/create_external_service_price_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_filtered_audience_endpoint_input.py b/src/rapidata/api_client/models/create_filtered_audience_endpoint_input.py index 286df7abdd..f3bdf3dfd8 100644 --- a/src/rapidata/api_client/models/create_filtered_audience_endpoint_input.py +++ b/src/rapidata/api_client/models/create_filtered_audience_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_filtered_audience_endpoint_output.py b/src/rapidata/api_client/models/create_filtered_audience_endpoint_output.py index e17177ec92..d66e7d3ccf 100644 --- a/src/rapidata/api_client/models/create_filtered_audience_endpoint_output.py +++ b/src/rapidata/api_client/models/create_filtered_audience_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_flow_endpoint_input.py b/src/rapidata/api_client/models/create_flow_endpoint_input.py index 6171e90f97..25ca1519df 100644 --- a/src/rapidata/api_client/models/create_flow_endpoint_input.py +++ b/src/rapidata/api_client/models/create_flow_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_flow_endpoint_output.py b/src/rapidata/api_client/models/create_flow_endpoint_output.py index d032740e3e..46dfc15cc5 100644 --- a/src/rapidata/api_client/models/create_flow_endpoint_output.py +++ b/src/rapidata/api_client/models/create_flow_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_flow_item_endpoint_input.py b/src/rapidata/api_client/models/create_flow_item_endpoint_input.py index 5b081f22ca..c852e5fa07 100644 --- a/src/rapidata/api_client/models/create_flow_item_endpoint_input.py +++ b/src/rapidata/api_client/models/create_flow_item_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_flow_item_endpoint_output.py b/src/rapidata/api_client/models/create_flow_item_endpoint_output.py index b97ea549fc..7a387cf330 100644 --- a/src/rapidata/api_client/models/create_flow_item_endpoint_output.py +++ b/src/rapidata/api_client/models/create_flow_item_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_global_billing_setting_endpoint_input.py b/src/rapidata/api_client/models/create_global_billing_setting_endpoint_input.py index 822ba6370f..1eda21bc42 100644 --- a/src/rapidata/api_client/models/create_global_billing_setting_endpoint_input.py +++ b/src/rapidata/api_client/models/create_global_billing_setting_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_global_text_endpoint_input.py b/src/rapidata/api_client/models/create_global_text_endpoint_input.py index 01097e2a0a..14173a9567 100644 --- a/src/rapidata/api_client/models/create_global_text_endpoint_input.py +++ b/src/rapidata/api_client/models/create_global_text_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_global_text_endpoint_output.py b/src/rapidata/api_client/models/create_global_text_endpoint_output.py index 871f62fdc4..401847b245 100644 --- a/src/rapidata/api_client/models/create_global_text_endpoint_output.py +++ b/src/rapidata/api_client/models/create_global_text_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_invoice_endpoint_input.py b/src/rapidata/api_client/models/create_invoice_endpoint_input.py index 1f8d1aae9f..51a5c6f079 100644 --- a/src/rapidata/api_client/models/create_invoice_endpoint_input.py +++ b/src/rapidata/api_client/models/create_invoice_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_invoice_endpoint_output.py b/src/rapidata/api_client/models/create_invoice_endpoint_output.py index 875c7ca21a..52e814d902 100644 --- a/src/rapidata/api_client/models/create_invoice_endpoint_output.py +++ b/src/rapidata/api_client/models/create_invoice_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_job_definition_endpoint_input.py b/src/rapidata/api_client/models/create_job_definition_endpoint_input.py index 71b83636cc..18759aff3c 100644 --- a/src/rapidata/api_client/models/create_job_definition_endpoint_input.py +++ b/src/rapidata/api_client/models/create_job_definition_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_job_definition_endpoint_output.py b/src/rapidata/api_client/models/create_job_definition_endpoint_output.py index a2cb4fe86a..778471493c 100644 --- a/src/rapidata/api_client/models/create_job_definition_endpoint_output.py +++ b/src/rapidata/api_client/models/create_job_definition_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_job_endpoint_cost_warning.py b/src/rapidata/api_client/models/create_job_endpoint_cost_warning.py index dccab27afe..66611777b2 100644 --- a/src/rapidata/api_client/models/create_job_endpoint_cost_warning.py +++ b/src/rapidata/api_client/models/create_job_endpoint_cost_warning.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_job_endpoint_input.py b/src/rapidata/api_client/models/create_job_endpoint_input.py index 062dd0cfcc..39a0ae5927 100644 --- a/src/rapidata/api_client/models/create_job_endpoint_input.py +++ b/src/rapidata/api_client/models/create_job_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_job_endpoint_output.py b/src/rapidata/api_client/models/create_job_endpoint_output.py index 714d64fab4..ff74a4e94c 100644 --- a/src/rapidata/api_client/models/create_job_endpoint_output.py +++ b/src/rapidata/api_client/models/create_job_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_job_revision_endpoint_input.py b/src/rapidata/api_client/models/create_job_revision_endpoint_input.py index fc74914bed..b2b46fa565 100644 --- a/src/rapidata/api_client/models/create_job_revision_endpoint_input.py +++ b/src/rapidata/api_client/models/create_job_revision_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_job_revision_endpoint_output.py b/src/rapidata/api_client/models/create_job_revision_endpoint_output.py index 82e7dcb715..b305e0a91c 100644 --- a/src/rapidata/api_client/models/create_job_revision_endpoint_output.py +++ b/src/rapidata/api_client/models/create_job_revision_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_leaderboard_endpoint_input.py b/src/rapidata/api_client/models/create_leaderboard_endpoint_input.py index 86ac6319ea..c277c1d6bc 100644 --- a/src/rapidata/api_client/models/create_leaderboard_endpoint_input.py +++ b/src/rapidata/api_client/models/create_leaderboard_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_leaderboard_endpoint_output.py b/src/rapidata/api_client/models/create_leaderboard_endpoint_output.py index ef5424345b..d8d77a3cbc 100644 --- a/src/rapidata/api_client/models/create_leaderboard_endpoint_output.py +++ b/src/rapidata/api_client/models/create_leaderboard_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_leaderboard_participant_endpoint_input.py b/src/rapidata/api_client/models/create_leaderboard_participant_endpoint_input.py index 901a2d6905..5f7a5123ea 100644 --- a/src/rapidata/api_client/models/create_leaderboard_participant_endpoint_input.py +++ b/src/rapidata/api_client/models/create_leaderboard_participant_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_leaderboard_participant_endpoint_output.py b/src/rapidata/api_client/models/create_leaderboard_participant_endpoint_output.py index 0bbeeb9570..0486ec897c 100644 --- a/src/rapidata/api_client/models/create_leaderboard_participant_endpoint_output.py +++ b/src/rapidata/api_client/models/create_leaderboard_participant_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_manual_charge_endpoint_input.py b/src/rapidata/api_client/models/create_manual_charge_endpoint_input.py index 54bc4f7045..bb2c9cc829 100644 --- a/src/rapidata/api_client/models/create_manual_charge_endpoint_input.py +++ b/src/rapidata/api_client/models/create_manual_charge_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_manual_charge_endpoint_output.py b/src/rapidata/api_client/models/create_manual_charge_endpoint_output.py index 195d7b3f49..1794107c1a 100644 --- a/src/rapidata/api_client/models/create_manual_charge_endpoint_output.py +++ b/src/rapidata/api_client/models/create_manual_charge_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_order.py b/src/rapidata/api_client/models/create_order.py index 43f3d5a857..e4240856c8 100644 --- a/src/rapidata/api_client/models/create_order.py +++ b/src/rapidata/api_client/models/create_order.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_order_endpoint_output.py b/src/rapidata/api_client/models/create_order_endpoint_output.py index f651d7da7b..b824114c5a 100644 --- a/src/rapidata/api_client/models/create_order_endpoint_output.py +++ b/src/rapidata/api_client/models/create_order_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_organization_billing_setting_endpoint_input.py b/src/rapidata/api_client/models/create_organization_billing_setting_endpoint_input.py index 305b5f2171..d519e19143 100644 --- a/src/rapidata/api_client/models/create_organization_billing_setting_endpoint_input.py +++ b/src/rapidata/api_client/models/create_organization_billing_setting_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_organization_endpoint_input.py b/src/rapidata/api_client/models/create_organization_endpoint_input.py index 018c84c00c..dcf6d33a6b 100644 --- a/src/rapidata/api_client/models/create_organization_endpoint_input.py +++ b/src/rapidata/api_client/models/create_organization_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_organization_endpoint_output.py b/src/rapidata/api_client/models/create_organization_endpoint_output.py index 2b5ff96347..3b7829274f 100644 --- a/src/rapidata/api_client/models/create_organization_endpoint_output.py +++ b/src/rapidata/api_client/models/create_organization_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_owner_tier_override_endpoint_input.py b/src/rapidata/api_client/models/create_owner_tier_override_endpoint_input.py index d0956e9a93..82d1db1863 100644 --- a/src/rapidata/api_client/models/create_owner_tier_override_endpoint_input.py +++ b/src/rapidata/api_client/models/create_owner_tier_override_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_owner_tier_override_endpoint_output.py b/src/rapidata/api_client/models/create_owner_tier_override_endpoint_output.py index 07a690033d..008512afdb 100644 --- a/src/rapidata/api_client/models/create_owner_tier_override_endpoint_output.py +++ b/src/rapidata/api_client/models/create_owner_tier_override_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_program_campaign_endpoint_input.py b/src/rapidata/api_client/models/create_program_campaign_endpoint_input.py index c46a41ee24..6326fe01ec 100644 --- a/src/rapidata/api_client/models/create_program_campaign_endpoint_input.py +++ b/src/rapidata/api_client/models/create_program_campaign_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_program_campaign_endpoint_output.py b/src/rapidata/api_client/models/create_program_campaign_endpoint_output.py index b8590a90cd..3bfc36707c 100644 --- a/src/rapidata/api_client/models/create_program_campaign_endpoint_output.py +++ b/src/rapidata/api_client/models/create_program_campaign_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_prompt_embedding_map_endpoint_output.py b/src/rapidata/api_client/models/create_prompt_embedding_map_endpoint_output.py index 676f725cde..e408a5cabb 100644 --- a/src/rapidata/api_client/models/create_prompt_embedding_map_endpoint_output.py +++ b/src/rapidata/api_client/models/create_prompt_embedding_map_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_prompt_for_benchmark_endpoint_input.py b/src/rapidata/api_client/models/create_prompt_for_benchmark_endpoint_input.py index 475e683bb6..b3dc5474da 100644 --- a/src/rapidata/api_client/models/create_prompt_for_benchmark_endpoint_input.py +++ b/src/rapidata/api_client/models/create_prompt_for_benchmark_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_prompt_for_benchmark_endpoint_output.py b/src/rapidata/api_client/models/create_prompt_for_benchmark_endpoint_output.py index 39f9fdb337..ad602640b9 100644 --- a/src/rapidata/api_client/models/create_prompt_for_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/create_prompt_for_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_prompt_for_leaderboard_endpoint_output.py b/src/rapidata/api_client/models/create_prompt_for_leaderboard_endpoint_output.py index 5759e410dd..9b62a8fb48 100644 --- a/src/rapidata/api_client/models/create_prompt_for_leaderboard_endpoint_output.py +++ b/src/rapidata/api_client/models/create_prompt_for_leaderboard_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_sample_endpoint_input.py b/src/rapidata/api_client/models/create_sample_endpoint_input.py index aca033fb81..c835e742cc 100644 --- a/src/rapidata/api_client/models/create_sample_endpoint_input.py +++ b/src/rapidata/api_client/models/create_sample_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_sample_endpoint_output.py b/src/rapidata/api_client/models/create_sample_endpoint_output.py index 0d24072d3b..3c12ddfa97 100644 --- a/src/rapidata/api_client/models/create_sample_endpoint_output.py +++ b/src/rapidata/api_client/models/create_sample_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_sample_generation_endpoint_input.py b/src/rapidata/api_client/models/create_sample_generation_endpoint_input.py index 7b5967b305..48181b4dfc 100644 --- a/src/rapidata/api_client/models/create_sample_generation_endpoint_input.py +++ b/src/rapidata/api_client/models/create_sample_generation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_sample_generation_endpoint_output.py b/src/rapidata/api_client/models/create_sample_generation_endpoint_output.py index e0922b3f01..3e09b076c2 100644 --- a/src/rapidata/api_client/models/create_sample_generation_endpoint_output.py +++ b/src/rapidata/api_client/models/create_sample_generation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_sample_new_endpoint_input.py b/src/rapidata/api_client/models/create_sample_new_endpoint_input.py index 05127b0728..60021c2a91 100644 --- a/src/rapidata/api_client/models/create_sample_new_endpoint_input.py +++ b/src/rapidata/api_client/models/create_sample_new_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_sample_new_endpoint_output.py b/src/rapidata/api_client/models/create_sample_new_endpoint_output.py index b7ce26fbc0..6988cbd885 100644 --- a/src/rapidata/api_client/models/create_sample_new_endpoint_output.py +++ b/src/rapidata/api_client/models/create_sample_new_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_signal_endpoint_input.py b/src/rapidata/api_client/models/create_signal_endpoint_input.py index ef59168b9a..f7198028e3 100644 --- a/src/rapidata/api_client/models/create_signal_endpoint_input.py +++ b/src/rapidata/api_client/models/create_signal_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_signal_endpoint_output.py b/src/rapidata/api_client/models/create_signal_endpoint_output.py index 7fe7507293..1ae483e4f4 100644 --- a/src/rapidata/api_client/models/create_signal_endpoint_output.py +++ b/src/rapidata/api_client/models/create_signal_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_top_up_endpoint_input.py b/src/rapidata/api_client/models/create_top_up_endpoint_input.py index 9f0ba39a5d..6b39c98159 100644 --- a/src/rapidata/api_client/models/create_top_up_endpoint_input.py +++ b/src/rapidata/api_client/models/create_top_up_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_top_up_endpoint_output.py b/src/rapidata/api_client/models/create_top_up_endpoint_output.py index fc35f2c192..796ae50c20 100644 --- a/src/rapidata/api_client/models/create_top_up_endpoint_output.py +++ b/src/rapidata/api_client/models/create_top_up_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_unsupported_order_endpoint_input.py b/src/rapidata/api_client/models/create_unsupported_order_endpoint_input.py index be5d6747c1..ae10cf2276 100644 --- a/src/rapidata/api_client/models/create_unsupported_order_endpoint_input.py +++ b/src/rapidata/api_client/models/create_unsupported_order_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_validation_feedback_endpoint_input.py b/src/rapidata/api_client/models/create_validation_feedback_endpoint_input.py index 7e41b75fd8..4d5f370e87 100644 --- a/src/rapidata/api_client/models/create_validation_feedback_endpoint_input.py +++ b/src/rapidata/api_client/models/create_validation_feedback_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_validation_set_endpoint_input.py b/src/rapidata/api_client/models/create_validation_set_endpoint_input.py index c88eda8d9b..c28b89f3b3 100644 --- a/src/rapidata/api_client/models/create_validation_set_endpoint_input.py +++ b/src/rapidata/api_client/models/create_validation_set_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_validation_set_endpoint_output.py b/src/rapidata/api_client/models/create_validation_set_endpoint_output.py index bb295bafb8..81deda89b3 100644 --- a/src/rapidata/api_client/models/create_validation_set_endpoint_output.py +++ b/src/rapidata/api_client/models/create_validation_set_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_volume_discount_endpoint_input.py b/src/rapidata/api_client/models/create_volume_discount_endpoint_input.py index 57cad9cf53..71a3f29f25 100644 --- a/src/rapidata/api_client/models/create_volume_discount_endpoint_input.py +++ b/src/rapidata/api_client/models/create_volume_discount_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/create_volume_discount_endpoint_output.py b/src/rapidata/api_client/models/create_volume_discount_endpoint_output.py index fbad3c8881..da418daf04 100644 --- a/src/rapidata/api_client/models/create_volume_discount_endpoint_output.py +++ b/src/rapidata/api_client/models/create_volume_discount_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/datapoint_state.py b/src/rapidata/api_client/models/datapoint_state.py index 0966681505..b51c97e83b 100644 --- a/src/rapidata/api_client/models/datapoint_state.py +++ b/src/rapidata/api_client/models/datapoint_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/definition_type.py b/src/rapidata/api_client/models/definition_type.py index bc16f88e52..0728310085 100644 --- a/src/rapidata/api_client/models/definition_type.py +++ b/src/rapidata/api_client/models/definition_type.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/delete_audience_example_endpoint_output.py b/src/rapidata/api_client/models/delete_audience_example_endpoint_output.py index f22a93d965..89c57a7099 100644 --- a/src/rapidata/api_client/models/delete_audience_example_endpoint_output.py +++ b/src/rapidata/api_client/models/delete_audience_example_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/device_type.py b/src/rapidata/api_client/models/device_type.py index 10ba88f62d..7bdf42fb8e 100644 --- a/src/rapidata/api_client/models/device_type.py +++ b/src/rapidata/api_client/models/device_type.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/dynamic_client_registration_request.py b/src/rapidata/api_client/models/dynamic_client_registration_request.py index def454d006..664d5240de 100644 --- a/src/rapidata/api_client/models/dynamic_client_registration_request.py +++ b/src/rapidata/api_client/models/dynamic_client_registration_request.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/elo_config.py b/src/rapidata/api_client/models/elo_config.py index 026c4e0ad3..ebe9fbdc80 100644 --- a/src/rapidata/api_client/models/elo_config.py +++ b/src/rapidata/api_client/models/elo_config.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/ensure_english_endpoint_input.py b/src/rapidata/api_client/models/ensure_english_endpoint_input.py index 9bf6a2988c..f43073ce86 100644 --- a/src/rapidata/api_client/models/ensure_english_endpoint_input.py +++ b/src/rapidata/api_client/models/ensure_english_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/ensure_english_endpoint_output.py b/src/rapidata/api_client/models/ensure_english_endpoint_output.py index c628d2e6f3..9067c7d7f1 100644 --- a/src/rapidata/api_client/models/ensure_english_endpoint_output.py +++ b/src/rapidata/api_client/models/ensure_english_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/example_box_shape.py b/src/rapidata/api_client/models/example_box_shape.py index 389aabdcea..d036cfb262 100644 --- a/src/rapidata/api_client/models/example_box_shape.py +++ b/src/rapidata/api_client/models/example_box_shape.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/example_category.py b/src/rapidata/api_client/models/example_category.py index 8d566342d0..eb9918d14b 100644 --- a/src/rapidata/api_client/models/example_category.py +++ b/src/rapidata/api_client/models/example_category.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/example_scrub_range.py b/src/rapidata/api_client/models/example_scrub_range.py index c50144dc58..2684ec6947 100644 --- a/src/rapidata/api_client/models/example_scrub_range.py +++ b/src/rapidata/api_client/models/example_scrub_range.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/example_transcription_word.py b/src/rapidata/api_client/models/example_transcription_word.py index 153e2e8006..b975bb3d68 100644 --- a/src/rapidata/api_client/models/example_transcription_word.py +++ b/src/rapidata/api_client/models/example_transcription_word.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/example_visibility.py b/src/rapidata/api_client/models/example_visibility.py index 200bf9f206..d01f762450 100644 --- a/src/rapidata/api_client/models/example_visibility.py +++ b/src/rapidata/api_client/models/example_visibility.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/existing_asset_input.py b/src/rapidata/api_client/models/existing_asset_input.py index 010a55d2a0..6c97a63cf3 100644 --- a/src/rapidata/api_client/models/existing_asset_input.py +++ b/src/rapidata/api_client/models/existing_asset_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/external_app_id.py b/src/rapidata/api_client/models/external_app_id.py index 38dcefc14f..25b1d38ccb 100644 --- a/src/rapidata/api_client/models/external_app_id.py +++ b/src/rapidata/api_client/models/external_app_id.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/external_service_kind.py b/src/rapidata/api_client/models/external_service_kind.py index 46dfe4be63..84e1480bfc 100644 --- a/src/rapidata/api_client/models/external_service_kind.py +++ b/src/rapidata/api_client/models/external_service_kind.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/feature_flag.py b/src/rapidata/api_client/models/feature_flag.py index 49b94c10e3..6806839330 100644 --- a/src/rapidata/api_client/models/feature_flag.py +++ b/src/rapidata/api_client/models/feature_flag.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/file_type.py b/src/rapidata/api_client/models/file_type.py index 5d3c2a9335..c15f094f72 100644 --- a/src/rapidata/api_client/models/file_type.py +++ b/src/rapidata/api_client/models/file_type.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/filter.py b/src/rapidata/api_client/models/filter.py deleted file mode 100644 index 5bfff60bfa..0000000000 --- a/src/rapidata/api_client/models/filter.py +++ /dev/null @@ -1,133 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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 rapidata.api_client.models.filter_operator import FilterOperator -from rapidata.api_client.models.logic_operator import LogicOperator -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class Filter(LazyValidatedModel): - """ - Filter - """ # noqa: E501 - var_field: Optional[StrictStr] = Field(default=None, alias="field") - value: Optional[Any] = None - operator: Optional[FilterOperator] = None - logic: Optional[LogicOperator] = None - filters: Optional[List[Filter]] = None - __properties: ClassVar[List[str]] = ["field", "value", "operator", "logic", "filters"] - - # model_config is inherited from LazyValidatedModel - - - 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 Filter 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 filters (list) - _items = [] - if self.filters: - for _item_filters in self.filters: - if _item_filters: - _items.append(_item_filters.to_dict()) - _dict['filters'] = _items - # set to None if var_field (nullable) is None - # and model_fields_set contains the field - if self.var_field is None and "var_field" in self.model_fields_set: - _dict['field'] = None - - # set to None if value (nullable) is None - # and model_fields_set contains the field - if self.value is None and "value" in self.model_fields_set: - _dict['value'] = None - - # set to None if operator (nullable) is None - # and model_fields_set contains the field - if self.operator is None and "operator" in self.model_fields_set: - _dict['operator'] = None - - # set to None if logic (nullable) is None - # and model_fields_set contains the field - if self.logic is None and "logic" in self.model_fields_set: - _dict['logic'] = None - - # set to None if filters (nullable) is None - # and model_fields_set contains the field - if self.filters is None and "filters" in self.model_fields_set: - _dict['filters'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of Filter from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "field": obj.get("field"), - "value": obj.get("value"), - "operator": obj.get("operator"), - "logic": obj.get("logic"), - "filters": [Filter.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - -# TODO: Rewrite to not use raise_errors -Filter.model_rebuild(raise_errors=False) - diff --git a/src/rapidata/api_client/models/filter_operator.py b/src/rapidata/api_client/models/filter_operator.py deleted file mode 100644 index f4ffd69a9d..0000000000 --- a/src/rapidata/api_client/models/filter_operator.py +++ /dev/null @@ -1,46 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -from __future__ import annotations -import json -from enum import Enum -from typing_extensions import Self - - -class FilterOperator(str, Enum): - """ - FilterOperator - """ - - """ - allowed enum values - """ - EQ = 'Eq' - NEQ = 'Neq' - GT = 'Gt' - GTE = 'Gte' - LT = 'Lt' - LTE = 'Lte' - CONTAINS = 'Contains' - STARTSWITH = 'StartsWith' - ENDSWITH = 'EndsWith' - IN = 'In' - NOTCONTAINS = 'NotContains' - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Create an instance of FilterOperator from a JSON string""" - return cls(json.loads(json_str)) - - diff --git a/src/rapidata/api_client/models/flow_item_state.py b/src/rapidata/api_client/models/flow_item_state.py index 3a909edf11..7825ee934d 100644 --- a/src/rapidata/api_client/models/flow_item_state.py +++ b/src/rapidata/api_client/models/flow_item_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/flow_type.py b/src/rapidata/api_client/models/flow_type.py index bb7952cfc1..fcfa7c070e 100644 --- a/src/rapidata/api_client/models/flow_type.py +++ b/src/rapidata/api_client/models/flow_type.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/fork_benchmark_endpoint_output.py b/src/rapidata/api_client/models/fork_benchmark_endpoint_output.py index 6836ea0a6d..44359719a9 100644 --- a/src/rapidata/api_client/models/fork_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/fork_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/gender_user_filter_gender.py b/src/rapidata/api_client/models/gender_user_filter_gender.py index cae222eeea..d80c05fa88 100644 --- a/src/rapidata/api_client/models/gender_user_filter_gender.py +++ b/src/rapidata/api_client/models/gender_user_filter_gender.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_active_billing_period_overview_endpoint_output.py b/src/rapidata/api_client/models/get_active_billing_period_overview_endpoint_output.py index 8a8697c872..f2ef5e207e 100644 --- a/src/rapidata/api_client/models/get_active_billing_period_overview_endpoint_output.py +++ b/src/rapidata/api_client/models/get_active_billing_period_overview_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_all_global_texts_endpoint_output.py b/src/rapidata/api_client/models/get_all_global_texts_endpoint_output.py index eb63eb9acb..543dd7b6db 100644 --- a/src/rapidata/api_client/models/get_all_global_texts_endpoint_output.py +++ b/src/rapidata/api_client/models/get_all_global_texts_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_all_global_texts_endpoint_output_item.py b/src/rapidata/api_client/models/get_all_global_texts_endpoint_output_item.py index 4783180b60..23f1a6ce73 100644 --- a/src/rapidata/api_client/models/get_all_global_texts_endpoint_output_item.py +++ b/src/rapidata/api_client/models/get_all_global_texts_endpoint_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_audience_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_audience_by_id_endpoint_output.py index 0b062412b5..82648b4ef6 100644 --- a/src/rapidata/api_client/models/get_audience_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_audience_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_audience_inactivity_sync_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_audience_inactivity_sync_by_id_endpoint_output.py index 8d208a8795..f59d8af235 100644 --- a/src/rapidata/api_client/models/get_audience_inactivity_sync_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_audience_inactivity_sync_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_audience_state_recalculation_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_audience_state_recalculation_by_id_endpoint_output.py index 5847c212f1..9a98d24774 100644 --- a/src/rapidata/api_client/models/get_audience_state_recalculation_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_audience_state_recalculation_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_audience_user_state_metrics_result.py b/src/rapidata/api_client/models/get_audience_user_state_metrics_result.py index 1f08243923..def0a4621d 100644 --- a/src/rapidata/api_client/models/get_audience_user_state_metrics_result.py +++ b/src/rapidata/api_client/models/get_audience_user_state_metrics_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_available_validation_sets_endpoint_output.py b/src/rapidata/api_client/models/get_available_validation_sets_endpoint_output.py index 398e76f0af..ca59fa2aed 100644 --- a/src/rapidata/api_client/models/get_available_validation_sets_endpoint_output.py +++ b/src/rapidata/api_client/models/get_available_validation_sets_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_available_validation_sets_endpoint_validation_set_overview_output.py b/src/rapidata/api_client/models/get_available_validation_sets_endpoint_validation_set_overview_output.py index 44ccbd97be..f807613c87 100644 --- a/src/rapidata/api_client/models/get_available_validation_sets_endpoint_validation_set_overview_output.py +++ b/src/rapidata/api_client/models/get_available_validation_sets_endpoint_validation_set_overview_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_batch_upload_result_endpoint_output.py b/src/rapidata/api_client/models/get_batch_upload_result_endpoint_output.py index a7d1e4cbb0..fb47fe0999 100644 --- a/src/rapidata/api_client/models/get_batch_upload_result_endpoint_output.py +++ b/src/rapidata/api_client/models/get_batch_upload_result_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_batch_upload_result_endpoint_url_output.py b/src/rapidata/api_client/models/get_batch_upload_result_endpoint_url_output.py index 7957dc2d3f..5d9202edbc 100644 --- a/src/rapidata/api_client/models/get_batch_upload_result_endpoint_url_output.py +++ b/src/rapidata/api_client/models/get_batch_upload_result_endpoint_url_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_batch_upload_status_endpoint_output.py b/src/rapidata/api_client/models/get_batch_upload_status_endpoint_output.py index e73baef16a..d69f35a4d5 100644 --- a/src/rapidata/api_client/models/get_batch_upload_status_endpoint_output.py +++ b/src/rapidata/api_client/models/get_batch_upload_status_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_benchmark_by_id_endpoint_output.py index 70f566da5e..d0689c151a 100644 --- a/src/rapidata/api_client/models/get_benchmark_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_benchmark_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output.py b/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output.py index b7e783dec7..a798a8a72d 100644 --- a/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output.py +++ b/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output_bucket.py b/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output_bucket.py index f521028f30..459a08fb3c 100644 --- a/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output_bucket.py +++ b/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output_bucket.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output_dimension_set.py b/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output_dimension_set.py index e8c15bf19d..97e3ae32ea 100644 --- a/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output_dimension_set.py +++ b/src/rapidata/api_client/models/get_benchmark_demographics_endpoint_output_dimension_set.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_endpoint_output.py b/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_endpoint_output.py index babf2c5a8c..de9198bb4d 100644 --- a/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_endpoint_output.py +++ b/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_history_endpoint_output.py b/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_history_endpoint_output.py index 64231feb6f..872ea6e06b 100644 --- a/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_history_endpoint_output.py +++ b/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_history_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_history_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_history_endpoint_paged_result_of_output.py index 9f559d5d6f..e66cad9c11 100644 --- a/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_history_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_benchmark_hugging_face_sync_history_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_matchup_breakdown_endpoint_output.py b/src/rapidata/api_client/models/get_benchmark_matchup_breakdown_endpoint_output.py index 74ff240ae7..40924fa01f 100644 --- a/src/rapidata/api_client/models/get_benchmark_matchup_breakdown_endpoint_output.py +++ b/src/rapidata/api_client/models/get_benchmark_matchup_breakdown_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_matchup_breakdown_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/get_benchmark_matchup_breakdown_endpoint_paged_result_of_output.py index 7657bb2269..916fa0dd70 100644 --- a/src/rapidata/api_client/models/get_benchmark_matchup_breakdown_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_benchmark_matchup_breakdown_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output.py b/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output.py index 340fe872fe..ed32e8a4a5 100644 --- a/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output.py +++ b/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output_output_item.py b/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output_output_item.py index 5728571d3f..78d8267958 100644 --- a/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output_output_item.py +++ b/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output_segment.py b/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output_segment.py index 6d1fdf77ae..dbcf0efe7c 100644 --- a/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output_segment.py +++ b/src/rapidata/api_client/models/get_benchmark_standings_breakdown_endpoint_output_segment.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output.py b/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output.py index cf67cece11..421e1432fb 100644 --- a/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output.py +++ b/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_output_item.py b/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_output_item.py index b6b27d673f..28f18f719a 100644 --- a/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_output_item.py +++ b/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_segment.py b/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_segment.py index 8c105510a5..cdfbafb275 100644 --- a/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_segment.py +++ b/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_segment.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_segment_item.py b/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_segment_item.py index e7cd171a7e..2108a64f00 100644 --- a/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_segment_item.py +++ b/src/rapidata/api_client/models/get_benchmark_standings_by_tag_endpoint_output_segment_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_bidder_relation_members_endpoint_cursor_paged_result_of_output.py b/src/rapidata/api_client/models/get_bidder_relation_members_endpoint_cursor_paged_result_of_output.py index aecdbdaae8..ced6a9ef26 100644 --- a/src/rapidata/api_client/models/get_bidder_relation_members_endpoint_cursor_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_bidder_relation_members_endpoint_cursor_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_bidder_relation_members_endpoint_output.py b/src/rapidata/api_client/models/get_bidder_relation_members_endpoint_output.py index a2f8358d2c..c465032292 100644 --- a/src/rapidata/api_client/models/get_bidder_relation_members_endpoint_output.py +++ b/src/rapidata/api_client/models/get_bidder_relation_members_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_billing_period_overview_endpoint_output.py b/src/rapidata/api_client/models/get_billing_period_overview_endpoint_output.py index 155a5832f9..5c0e127818 100644 --- a/src/rapidata/api_client/models/get_billing_period_overview_endpoint_output.py +++ b/src/rapidata/api_client/models/get_billing_period_overview_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_billing_settings_timeline_endpoint_output.py b/src/rapidata/api_client/models/get_billing_settings_timeline_endpoint_output.py index 64667e4555..1e21fc41ee 100644 --- a/src/rapidata/api_client/models/get_billing_settings_timeline_endpoint_output.py +++ b/src/rapidata/api_client/models/get_billing_settings_timeline_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_billing_settings_timeline_endpoint_output_interval.py b/src/rapidata/api_client/models/get_billing_settings_timeline_endpoint_output_interval.py index 563be32102..2de4c301bb 100644 --- a/src/rapidata/api_client/models/get_billing_settings_timeline_endpoint_output_interval.py +++ b/src/rapidata/api_client/models/get_billing_settings_timeline_endpoint_output_interval.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_billing_summary_endpoint_output.py b/src/rapidata/api_client/models/get_billing_summary_endpoint_output.py index 6cf4fe87e1..6a214d7741 100644 --- a/src/rapidata/api_client/models/get_billing_summary_endpoint_output.py +++ b/src/rapidata/api_client/models/get_billing_summary_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_boost_insights_endpoint_audience_output.py b/src/rapidata/api_client/models/get_boost_insights_endpoint_audience_output.py index 4ebe66856e..9df4a8d112 100644 --- a/src/rapidata/api_client/models/get_boost_insights_endpoint_audience_output.py +++ b/src/rapidata/api_client/models/get_boost_insights_endpoint_audience_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_boost_insights_endpoint_contributor_output.py b/src/rapidata/api_client/models/get_boost_insights_endpoint_contributor_output.py index 66c624e730..9af0e4c96b 100644 --- a/src/rapidata/api_client/models/get_boost_insights_endpoint_contributor_output.py +++ b/src/rapidata/api_client/models/get_boost_insights_endpoint_contributor_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_boost_insights_endpoint_global_boost_output.py b/src/rapidata/api_client/models/get_boost_insights_endpoint_global_boost_output.py index ea07253f4f..5d3c1cad1b 100644 --- a/src/rapidata/api_client/models/get_boost_insights_endpoint_global_boost_output.py +++ b/src/rapidata/api_client/models/get_boost_insights_endpoint_global_boost_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_boost_insights_endpoint_language_boost_output.py b/src/rapidata/api_client/models/get_boost_insights_endpoint_language_boost_output.py index cc9860a656..455e3688db 100644 --- a/src/rapidata/api_client/models/get_boost_insights_endpoint_language_boost_output.py +++ b/src/rapidata/api_client/models/get_boost_insights_endpoint_language_boost_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_boost_insights_endpoint_level_contributor_output.py b/src/rapidata/api_client/models/get_boost_insights_endpoint_level_contributor_output.py index feb5db1dd2..bac68ca692 100644 --- a/src/rapidata/api_client/models/get_boost_insights_endpoint_level_contributor_output.py +++ b/src/rapidata/api_client/models/get_boost_insights_endpoint_level_contributor_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_boost_insights_endpoint_leveled_audience_output.py b/src/rapidata/api_client/models/get_boost_insights_endpoint_leveled_audience_output.py index 8bea53f981..d59c52f6c5 100644 --- a/src/rapidata/api_client/models/get_boost_insights_endpoint_leveled_audience_output.py +++ b/src/rapidata/api_client/models/get_boost_insights_endpoint_leveled_audience_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_boost_insights_endpoint_output.py b/src/rapidata/api_client/models/get_boost_insights_endpoint_output.py index 3c85e39881..6b6e389ec6 100644 --- a/src/rapidata/api_client/models/get_boost_insights_endpoint_output.py +++ b/src/rapidata/api_client/models/get_boost_insights_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_boost_status_endpoint_output.py b/src/rapidata/api_client/models/get_boost_status_endpoint_output.py index 1c8f692184..910d640672 100644 --- a/src/rapidata/api_client/models/get_boost_status_endpoint_output.py +++ b/src/rapidata/api_client/models/get_boost_status_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_bulk_close_billing_periods_status_endpoint_output.py b/src/rapidata/api_client/models/get_bulk_close_billing_periods_status_endpoint_output.py index a33bbe66da..e38fa0151b 100644 --- a/src/rapidata/api_client/models/get_bulk_close_billing_periods_status_endpoint_output.py +++ b/src/rapidata/api_client/models/get_bulk_close_billing_periods_status_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_bulk_close_billing_periods_status_endpoint_output_period.py b/src/rapidata/api_client/models/get_bulk_close_billing_periods_status_endpoint_output_period.py index c27b35ecbe..3d295e17e4 100644 --- a/src/rapidata/api_client/models/get_bulk_close_billing_periods_status_endpoint_output_period.py +++ b/src/rapidata/api_client/models/get_bulk_close_billing_periods_status_endpoint_output_period.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_bulk_reconciliation_status_endpoint_output.py b/src/rapidata/api_client/models/get_bulk_reconciliation_status_endpoint_output.py index 8a8fd9d643..9a1ec2108c 100644 --- a/src/rapidata/api_client/models/get_bulk_reconciliation_status_endpoint_output.py +++ b/src/rapidata/api_client/models/get_bulk_reconciliation_status_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details.py b/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details.py index b48b990d97..e188c6e71f 100644 --- a/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details.py +++ b/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details_get_campaign_by_id_endpoint_program_campaign_details.py b/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details_get_campaign_by_id_endpoint_program_campaign_details.py index a1e6789c57..f5fc9a2c50 100644 --- a/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details_get_campaign_by_id_endpoint_program_campaign_details.py +++ b/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details_get_campaign_by_id_endpoint_program_campaign_details.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details_get_campaign_by_id_endpoint_routed_campaign_details.py b/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details_get_campaign_by_id_endpoint_routed_campaign_details.py index 4258e3247b..2eaefa584f 100644 --- a/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details_get_campaign_by_id_endpoint_routed_campaign_details.py +++ b/src/rapidata/api_client/models/get_campaign_by_id_endpoint_i_campaign_details_get_campaign_by_id_endpoint_routed_campaign_details.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_campaign_cache_endpoint_campaign_entry.py b/src/rapidata/api_client/models/get_campaign_cache_endpoint_campaign_entry.py index fd8506f400..cbaeec9f8c 100644 --- a/src/rapidata/api_client/models/get_campaign_cache_endpoint_campaign_entry.py +++ b/src/rapidata/api_client/models/get_campaign_cache_endpoint_campaign_entry.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_campaign_cache_endpoint_output.py b/src/rapidata/api_client/models/get_campaign_cache_endpoint_output.py index 3163d9be97..84f454f018 100644 --- a/src/rapidata/api_client/models/get_campaign_cache_endpoint_output.py +++ b/src/rapidata/api_client/models/get_campaign_cache_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_capability_grantees_endpoint_cursor_paged_result_of_output.py b/src/rapidata/api_client/models/get_capability_grantees_endpoint_cursor_paged_result_of_output.py index 7e44904da9..5fbfeed930 100644 --- a/src/rapidata/api_client/models/get_capability_grantees_endpoint_cursor_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_capability_grantees_endpoint_cursor_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_capability_grantees_endpoint_output.py b/src/rapidata/api_client/models/get_capability_grantees_endpoint_output.py index 54ae15d583..004bf76a26 100644 --- a/src/rapidata/api_client/models/get_capability_grantees_endpoint_output.py +++ b/src/rapidata/api_client/models/get_capability_grantees_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_checkout_session_endpoint_output.py b/src/rapidata/api_client/models/get_checkout_session_endpoint_output.py index 46931b04e0..ec05754b98 100644 --- a/src/rapidata/api_client/models/get_checkout_session_endpoint_output.py +++ b/src/rapidata/api_client/models/get_checkout_session_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_combined_benchmark_matrix_endpoint_output.py b/src/rapidata/api_client/models/get_combined_benchmark_matrix_endpoint_output.py index df735ef46c..968908ab63 100644 --- a/src/rapidata/api_client/models/get_combined_benchmark_matrix_endpoint_output.py +++ b/src/rapidata/api_client/models/get_combined_benchmark_matrix_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_combined_benchmark_standings_endpoint_output.py b/src/rapidata/api_client/models/get_combined_benchmark_standings_endpoint_output.py index c406f89bbf..620da2b93a 100644 --- a/src/rapidata/api_client/models/get_combined_benchmark_standings_endpoint_output.py +++ b/src/rapidata/api_client/models/get_combined_benchmark_standings_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_combined_benchmark_standings_endpoint_output_item.py b/src/rapidata/api_client/models/get_combined_benchmark_standings_endpoint_output_item.py index 97fe8c5030..8eb96973a8 100644 --- a/src/rapidata/api_client/models/get_combined_benchmark_standings_endpoint_output_item.py +++ b/src/rapidata/api_client/models/get_combined_benchmark_standings_endpoint_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_combined_leaderboard_matrix_endpoint_output.py b/src/rapidata/api_client/models/get_combined_leaderboard_matrix_endpoint_output.py index ea8a567521..adeef776a5 100644 --- a/src/rapidata/api_client/models/get_combined_leaderboard_matrix_endpoint_output.py +++ b/src/rapidata/api_client/models/get_combined_leaderboard_matrix_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_combined_leaderboard_standings_endpoint_output.py b/src/rapidata/api_client/models/get_combined_leaderboard_standings_endpoint_output.py index 17d857aa69..16ebaebdd3 100644 --- a/src/rapidata/api_client/models/get_combined_leaderboard_standings_endpoint_output.py +++ b/src/rapidata/api_client/models/get_combined_leaderboard_standings_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_combined_leaderboard_standings_endpoint_output_item.py b/src/rapidata/api_client/models/get_combined_leaderboard_standings_endpoint_output_item.py index 9da92eabc6..9d8ff04e53 100644 --- a/src/rapidata/api_client/models/get_combined_leaderboard_standings_endpoint_output_item.py +++ b/src/rapidata/api_client/models/get_combined_leaderboard_standings_endpoint_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_compare_workflow_results_model.py b/src/rapidata/api_client/models/get_compare_workflow_results_model.py deleted file mode 100644 index f5312efef1..0000000000 --- a/src/rapidata/api_client/models/get_compare_workflow_results_model.py +++ /dev/null @@ -1,106 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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 -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.page_info import PageInfo -from rapidata.api_client.models.sort_criterion import SortCriterion -from typing import Optional, Set -from typing_extensions import Self - -class GetCompareWorkflowResultsModel(BaseModel): - """ - Model for getting the overview of a compare workflow result. - """ # noqa: E501 - page: Optional[PageInfo] = Field(default=None, description="The size of the page and the page number to display.") - sort_criteria: Optional[List[SortCriterion]] = Field(default=None, alias="sortCriteria") - __properties: ClassVar[List[str]] = ["page", "sortCriteria"] - - 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 GetCompareWorkflowResultsModel 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 page - if self.page: - _dict['page'] = self.page.to_dict() - # override the default output from pydantic by calling `to_dict()` of each item in sort_criteria (list) - _items = [] - if self.sort_criteria: - for _item_sort_criteria in self.sort_criteria: - if _item_sort_criteria: - _items.append(_item_sort_criteria.to_dict()) - _dict['sortCriteria'] = _items - # set to None if sort_criteria (nullable) is None - # and model_fields_set contains the field - if self.sort_criteria is None and "sort_criteria" in self.model_fields_set: - _dict['sortCriteria'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetCompareWorkflowResultsModel from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _obj = cls.model_validate({ - "page": PageInfo.from_dict(obj["page"]) if obj.get("page") is not None else None, - "sortCriteria": [SortCriterion.from_dict(_item) for _item in obj["sortCriteria"]] if obj.get("sortCriteria") is not None else None - }) - return _obj - - diff --git a/src/rapidata/api_client/models/get_compare_workflow_results_result.py b/src/rapidata/api_client/models/get_compare_workflow_results_result.py deleted file mode 100644 index 763bde6179..0000000000 --- a/src/rapidata/api_client/models/get_compare_workflow_results_result.py +++ /dev/null @@ -1,105 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictInt -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.get_compare_workflow_results_result_datapoint import GetCompareWorkflowResultsResultDatapoint -from typing import Optional, Set -from typing_extensions import Self - -class GetCompareWorkflowResultsResult(BaseModel): - """ - GetCompareWorkflowResultsResult - """ # noqa: E501 - total_votes: StrictInt = Field(alias="totalVotes") - total: StrictInt - page: StrictInt - page_size: StrictInt = Field(alias="pageSize") - items: List[GetCompareWorkflowResultsResultDatapoint] - total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages") - __properties: ClassVar[List[str]] = ["totalVotes", "total", "page", "pageSize", "items", "totalPages"] - - 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 GetCompareWorkflowResultsResult 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 items (list) - _items = [] - if self.items: - for _item_items in self.items: - if _item_items: - _items.append(_item_items.to_dict()) - _dict['items'] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetCompareWorkflowResultsResult from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _obj = cls.model_validate({ - "totalVotes": obj.get("totalVotes"), - "total": obj.get("total"), - "page": obj.get("page"), - "pageSize": obj.get("pageSize"), - "items": [GetCompareWorkflowResultsResultDatapoint.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, - "totalPages": obj.get("totalPages") - }) - return _obj - - diff --git a/src/rapidata/api_client/models/get_compare_workflow_results_result_datapoint.py b/src/rapidata/api_client/models/get_compare_workflow_results_result_datapoint.py deleted file mode 100644 index 4ca9e71a8c..0000000000 --- a/src/rapidata/api_client/models/get_compare_workflow_results_result_datapoint.py +++ /dev/null @@ -1,95 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List -from rapidata.api_client.models.i_asset_model import IAssetModel -from typing import Optional, Set -from typing_extensions import Self - -class GetCompareWorkflowResultsResultDatapoint(BaseModel): - """ - GetCompareWorkflowResultsResultDatapoint - """ # noqa: E501 - workflow_datapoint_id: StrictStr = Field(alias="workflowDatapointId") - asset: IAssetModel - elo: StrictInt - __properties: ClassVar[List[str]] = ["workflowDatapointId", "asset", "elo"] - - 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 GetCompareWorkflowResultsResultDatapoint 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 asset - if self.asset: - _dict['asset'] = self.asset.to_dict() - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetCompareWorkflowResultsResultDatapoint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _obj = cls.model_validate({ - "workflowDatapointId": obj.get("workflowDatapointId"), - "asset": IAssetModel.from_dict(obj["asset"]) if obj.get("asset") is not None else None, - "elo": obj.get("elo") - }) - return _obj - - diff --git a/src/rapidata/api_client/models/get_compatible_validation_sets_endpoint_output.py b/src/rapidata/api_client/models/get_compatible_validation_sets_endpoint_output.py index 43e0394e0e..d2846b37ae 100644 --- a/src/rapidata/api_client/models/get_compatible_validation_sets_endpoint_output.py +++ b/src/rapidata/api_client/models/get_compatible_validation_sets_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_compatible_validation_sets_endpoint_validation_set_output.py b/src/rapidata/api_client/models/get_compatible_validation_sets_endpoint_validation_set_output.py index fd04fa2d1c..8cbf1799a8 100644 --- a/src/rapidata/api_client/models/get_compatible_validation_sets_endpoint_validation_set_output.py +++ b/src/rapidata/api_client/models/get_compatible_validation_sets_endpoint_validation_set_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_completion_time_histogram_endpoint_output.py b/src/rapidata/api_client/models/get_completion_time_histogram_endpoint_output.py index 3b286fe235..aff452cf17 100644 --- a/src/rapidata/api_client/models/get_completion_time_histogram_endpoint_output.py +++ b/src/rapidata/api_client/models/get_completion_time_histogram_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_completion_time_histogram_endpoint_output_bucket.py b/src/rapidata/api_client/models/get_completion_time_histogram_endpoint_output_bucket.py index b76ecf4dca..61d1c21caf 100644 --- a/src/rapidata/api_client/models/get_completion_time_histogram_endpoint_output_bucket.py +++ b/src/rapidata/api_client/models/get_completion_time_histogram_endpoint_output_bucket.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_cost_time_series_endpoint_cost_data_point.py b/src/rapidata/api_client/models/get_cost_time_series_endpoint_cost_data_point.py index 73efbf51c6..80bc99df5e 100644 --- a/src/rapidata/api_client/models/get_cost_time_series_endpoint_cost_data_point.py +++ b/src/rapidata/api_client/models/get_cost_time_series_endpoint_cost_data_point.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_cost_time_series_endpoint_output.py b/src/rapidata/api_client/models/get_cost_time_series_endpoint_output.py index 54e0fc1d68..8a6fa2fa70 100644 --- a/src/rapidata/api_client/models/get_cost_time_series_endpoint_output.py +++ b/src/rapidata/api_client/models/get_cost_time_series_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_customer_capabilities_endpoint_output.py b/src/rapidata/api_client/models/get_customer_capabilities_endpoint_output.py index ee4c6ef2ac..4d41a79e26 100644 --- a/src/rapidata/api_client/models/get_customer_capabilities_endpoint_output.py +++ b/src/rapidata/api_client/models/get_customer_capabilities_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_datapoint_endpoint_output.py b/src/rapidata/api_client/models/get_datapoint_endpoint_output.py index 60ea90c5ca..dd9e310e2c 100644 --- a/src/rapidata/api_client/models/get_datapoint_endpoint_output.py +++ b/src/rapidata/api_client/models/get_datapoint_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_dataset_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_dataset_by_id_endpoint_output.py index aba017c320..1763b8fa95 100644 --- a/src/rapidata/api_client/models/get_dataset_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_dataset_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_dataset_progress_endpoint_output.py b/src/rapidata/api_client/models/get_dataset_progress_endpoint_output.py index 7ddf97bf17..18174e3d1e 100644 --- a/src/rapidata/api_client/models/get_dataset_progress_endpoint_output.py +++ b/src/rapidata/api_client/models/get_dataset_progress_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_evaluation_workflow_results_model.py b/src/rapidata/api_client/models/get_evaluation_workflow_results_model.py deleted file mode 100644 index 73e0d545c6..0000000000 --- a/src/rapidata/api_client/models/get_evaluation_workflow_results_model.py +++ /dev/null @@ -1,107 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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 -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.pagination import Pagination -from rapidata.api_client.models.rapid_state import RapidState -from rapidata.api_client.models.sort_criteria import SortCriteria -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetEvaluationWorkflowResultsModel(LazyValidatedModel): - """ - Model for getting the overview of a simple workflow result. - """ # noqa: E501 - page: Optional[Pagination] = Field(default=None, description="The size of the page and the page number to display.") - states: Optional[List[RapidState]] = None - sort_criteria: Optional[SortCriteria] = Field(default=None, description="A list of criteria to sort the results by.", alias="sortCriteria") - __properties: ClassVar[List[str]] = ["page", "states", "sortCriteria"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetEvaluationWorkflowResultsModel 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 page - if self.page: - _dict['page'] = self.page.to_dict() - # override the default output from pydantic by calling `to_dict()` of sort_criteria - if self.sort_criteria: - _dict['sortCriteria'] = self.sort_criteria.to_dict() - # set to None if states (nullable) is None - # and model_fields_set contains the field - if self.states is None and "states" in self.model_fields_set: - _dict['states'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetEvaluationWorkflowResultsModel from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "page": Pagination.from_dict(obj["page"]) if obj.get("page") is not None else None, - "states": obj.get("states"), - "sortCriteria": SortCriteria.from_dict(obj["sortCriteria"]) if obj.get("sortCriteria") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_external_app_relation_members_endpoint_cursor_paged_result_of_output.py b/src/rapidata/api_client/models/get_external_app_relation_members_endpoint_cursor_paged_result_of_output.py index 3c90d28a00..83ac6c2b01 100644 --- a/src/rapidata/api_client/models/get_external_app_relation_members_endpoint_cursor_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_external_app_relation_members_endpoint_cursor_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_external_app_relation_members_endpoint_output.py b/src/rapidata/api_client/models/get_external_app_relation_members_endpoint_output.py index c202b76d22..ac5822d20d 100644 --- a/src/rapidata/api_client/models/get_external_app_relation_members_endpoint_output.py +++ b/src/rapidata/api_client/models/get_external_app_relation_members_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_failed_datapoints_endpoint_datapoint.py b/src/rapidata/api_client/models/get_failed_datapoints_endpoint_datapoint.py index 8df8eab45e..6c9edb7752 100644 --- a/src/rapidata/api_client/models/get_failed_datapoints_endpoint_datapoint.py +++ b/src/rapidata/api_client/models/get_failed_datapoints_endpoint_datapoint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_failed_datapoints_endpoint_output.py b/src/rapidata/api_client/models/get_failed_datapoints_endpoint_output.py index ca236ce6ae..02e9784e31 100644 --- a/src/rapidata/api_client/models/get_failed_datapoints_endpoint_output.py +++ b/src/rapidata/api_client/models/get_failed_datapoints_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_fast_bid_multiplier_endpoint_output.py b/src/rapidata/api_client/models/get_fast_bid_multiplier_endpoint_output.py index f1f7cd5e16..574b19cad2 100644 --- a/src/rapidata/api_client/models/get_fast_bid_multiplier_endpoint_output.py +++ b/src/rapidata/api_client/models/get_fast_bid_multiplier_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_flow_item_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_flow_item_by_id_endpoint_output.py index ee69bcad32..2ac5011977 100644 --- a/src/rapidata/api_client/models/get_flow_item_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_flow_item_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_flow_item_creation_timeseries_endpoint_output.py b/src/rapidata/api_client/models/get_flow_item_creation_timeseries_endpoint_output.py index 8d5b00bcb9..9183c88b26 100644 --- a/src/rapidata/api_client/models/get_flow_item_creation_timeseries_endpoint_output.py +++ b/src/rapidata/api_client/models/get_flow_item_creation_timeseries_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_flow_item_creation_timeseries_endpoint_output_data_point.py b/src/rapidata/api_client/models/get_flow_item_creation_timeseries_endpoint_output_data_point.py index 1778da1e8c..f923b5fbbd 100644 --- a/src/rapidata/api_client/models/get_flow_item_creation_timeseries_endpoint_output_data_point.py +++ b/src/rapidata/api_client/models/get_flow_item_creation_timeseries_endpoint_output_data_point.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_global_responses_endpoint_output.py b/src/rapidata/api_client/models/get_global_responses_endpoint_output.py index 46a971b5b2..4e73482bf9 100644 --- a/src/rapidata/api_client/models/get_global_responses_endpoint_output.py +++ b/src/rapidata/api_client/models/get_global_responses_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_global_responses_endpoint_output_response.py b/src/rapidata/api_client/models/get_global_responses_endpoint_output_response.py index 428d4881f7..444532669f 100644 --- a/src/rapidata/api_client/models/get_global_responses_endpoint_output_response.py +++ b/src/rapidata/api_client/models/get_global_responses_endpoint_output_response.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_grouped_ranking_workflow_results_result.py b/src/rapidata/api_client/models/get_grouped_ranking_workflow_results_result.py deleted file mode 100644 index 56c4c2d3df..0000000000 --- a/src/rapidata/api_client/models/get_grouped_ranking_workflow_results_result.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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 -from rapidata.api_client.models.i_pair_maker_information import IPairMakerInformation -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetGroupedRankingWorkflowResultsResult(LazyValidatedModel): - """ - GetGroupedRankingWorkflowResultsResult - """ # noqa: E501 - id: StrictStr - name: StrictStr - state: StrictStr - pair_maker_information: IPairMakerInformation = Field(alias="pairMakerInformation") - __properties: ClassVar[List[str]] = ["id", "name", "state", "pairMakerInformation"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetGroupedRankingWorkflowResultsResult 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 pair_maker_information - if self.pair_maker_information: - _dict['pairMakerInformation'] = self.pair_maker_information.to_dict() - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetGroupedRankingWorkflowResultsResult from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "id": obj.get("id"), - "name": obj.get("name"), - "state": obj.get("state"), - "pairMakerInformation": IPairMakerInformation.from_dict(obj["pairMakerInformation"]) if obj.get("pairMakerInformation") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_invoice_endpoint_output.py b/src/rapidata/api_client/models/get_invoice_endpoint_output.py index 785da7e9b3..32d35f41d7 100644 --- a/src/rapidata/api_client/models/get_invoice_endpoint_output.py +++ b/src/rapidata/api_client/models/get_invoice_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_ab_summary_endpoint_output.py b/src/rapidata/api_client/models/get_job_ab_summary_endpoint_output.py index 3b2ecf2712..558d08b824 100644 --- a/src/rapidata/api_client/models/get_job_ab_summary_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_ab_summary_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_job_by_id_endpoint_output.py index 043e4629dd..789c797aec 100644 --- a/src/rapidata/api_client/models/get_job_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_cost_estimate_endpoint_output.py b/src/rapidata/api_client/models/get_job_cost_estimate_endpoint_output.py index b2fa66625f..32a2f353eb 100644 --- a/src/rapidata/api_client/models/get_job_cost_estimate_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_cost_estimate_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_datapoints_endpoint_output.py b/src/rapidata/api_client/models/get_job_datapoints_endpoint_output.py index 7c4c182bcf..ce408fe8ec 100644 --- a/src/rapidata/api_client/models/get_job_datapoints_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_datapoints_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_datapoints_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/get_job_datapoints_endpoint_paged_result_of_output.py index 87cbf3817e..05259f9517 100644 --- a/src/rapidata/api_client/models/get_job_datapoints_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_job_datapoints_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_definition_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_job_definition_by_id_endpoint_output.py index d114acec84..fdbbd56f88 100644 --- a/src/rapidata/api_client/models/get_job_definition_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_definition_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_definition_cost_estimate_endpoint_output.py b/src/rapidata/api_client/models/get_job_definition_cost_estimate_endpoint_output.py index 5312cb0fdd..2946275f10 100644 --- a/src/rapidata/api_client/models/get_job_definition_cost_estimate_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_definition_cost_estimate_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_progress_endpoint_output.py b/src/rapidata/api_client/models/get_job_progress_endpoint_output.py index bd8838b296..51f7c5fff7 100644 --- a/src/rapidata/api_client/models/get_job_progress_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_progress_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_responses_endpoint_output.py b/src/rapidata/api_client/models/get_job_responses_endpoint_output.py index c026bc8d39..4e4790a71e 100644 --- a/src/rapidata/api_client/models/get_job_responses_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_responses_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_responses_endpoint_output_response.py b/src/rapidata/api_client/models/get_job_responses_endpoint_output_response.py index c787f0baba..2f1e5323c4 100644 --- a/src/rapidata/api_client/models/get_job_responses_endpoint_output_response.py +++ b/src/rapidata/api_client/models/get_job_responses_endpoint_output_response.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_result_navigation_endpoint_output.py b/src/rapidata/api_client/models/get_job_result_navigation_endpoint_output.py index 1f387a06a1..7872fe7460 100644 --- a/src/rapidata/api_client/models/get_job_result_navigation_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_result_navigation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_job_revision_endpoint_output.py b/src/rapidata/api_client/models/get_job_revision_endpoint_output.py index 3882c04a8b..187587bb84 100644 --- a/src/rapidata/api_client/models/get_job_revision_endpoint_output.py +++ b/src/rapidata/api_client/models/get_job_revision_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_latest_audience_inactivity_sync_endpoint_output.py b/src/rapidata/api_client/models/get_latest_audience_inactivity_sync_endpoint_output.py index a5a3d1e5d0..ce3d06bed4 100644 --- a/src/rapidata/api_client/models/get_latest_audience_inactivity_sync_endpoint_output.py +++ b/src/rapidata/api_client/models/get_latest_audience_inactivity_sync_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_latest_audience_state_recalculation_endpoint_output.py b/src/rapidata/api_client/models/get_latest_audience_state_recalculation_endpoint_output.py index dd7ccb582e..c682c04a23 100644 --- a/src/rapidata/api_client/models/get_latest_audience_state_recalculation_endpoint_output.py +++ b/src/rapidata/api_client/models/get_latest_audience_state_recalculation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_leaderboard_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_leaderboard_by_id_endpoint_output.py index 132f2a18dc..658f1e474a 100644 --- a/src/rapidata/api_client/models/get_leaderboard_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_leaderboard_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_order_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_order_by_id_endpoint_output.py index b6c0373467..41c4603932 100644 --- a/src/rapidata/api_client/models/get_order_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_order_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_organization_capabilities_endpoint_output.py b/src/rapidata/api_client/models/get_organization_capabilities_endpoint_output.py index 5f0cea27e3..ab8f233f04 100644 --- a/src/rapidata/api_client/models/get_organization_capabilities_endpoint_output.py +++ b/src/rapidata/api_client/models/get_organization_capabilities_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_organization_endpoint_output.py b/src/rapidata/api_client/models/get_organization_endpoint_output.py index f44207d252..4204a68c05 100644 --- a/src/rapidata/api_client/models/get_organization_endpoint_output.py +++ b/src/rapidata/api_client/models/get_organization_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_organization_owner_tier_endpoint_output.py b/src/rapidata/api_client/models/get_organization_owner_tier_endpoint_output.py index c501ca8879..584781cefd 100644 --- a/src/rapidata/api_client/models/get_organization_owner_tier_endpoint_output.py +++ b/src/rapidata/api_client/models/get_organization_owner_tier_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_participant_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_participant_by_id_endpoint_output.py index 6d86c1dd8c..d15e9e792e 100644 --- a/src/rapidata/api_client/models/get_participant_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_participant_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_pipeline_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_pipeline_by_id_endpoint_output.py deleted file mode 100644 index e151fd8a98..0000000000 --- a/src/rapidata/api_client/models/get_pipeline_by_id_endpoint_output.py +++ /dev/null @@ -1,111 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from typing import Any, ClassVar, Dict, List -from rapidata.api_client.models.feature_flag import FeatureFlag -from rapidata.api_client.models.i_artifact import IArtifact -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetPipelineByIdEndpointOutput(LazyValidatedModel): - """ - GetPipelineByIdEndpointOutput - """ # noqa: E501 - artifacts: Dict[str, IArtifact] = Field(description="The artifacts attached to the pipeline, keyed by their role.") - feature_flags: List[FeatureFlag] = Field(alias="featureFlags") - __properties: ClassVar[List[str]] = ["artifacts", "featureFlags"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetPipelineByIdEndpointOutput 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 value in artifacts (dict) - _field_dict = {} - if self.artifacts: - for _key_artifacts in self.artifacts: - if self.artifacts[_key_artifacts]: - _field_dict[_key_artifacts] = self.artifacts[_key_artifacts].to_dict() - _dict['artifacts'] = _field_dict - # override the default output from pydantic by calling `to_dict()` of each item in feature_flags (list) - _items = [] - if self.feature_flags: - for _item_feature_flags in self.feature_flags: - if _item_feature_flags: - _items.append(_item_feature_flags.to_dict()) - _dict['featureFlags'] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetPipelineByIdEndpointOutput from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "artifacts": dict( - (_k, IArtifact.from_dict(_v)) - for _k, _v in obj["artifacts"].items() - ) - if obj.get("artifacts") is not None - else None, - "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_platform_relation_members_endpoint_cursor_paged_result_of_output.py b/src/rapidata/api_client/models/get_platform_relation_members_endpoint_cursor_paged_result_of_output.py index 2a49036d8d..fdfa4d6046 100644 --- a/src/rapidata/api_client/models/get_platform_relation_members_endpoint_cursor_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_platform_relation_members_endpoint_cursor_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_platform_relation_members_endpoint_output.py b/src/rapidata/api_client/models/get_platform_relation_members_endpoint_output.py index c4774b18b8..96f0c1b6d7 100644 --- a/src/rapidata/api_client/models/get_platform_relation_members_endpoint_output.py +++ b/src/rapidata/api_client/models/get_platform_relation_members_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_prompt_embedding_map_endpoint_output.py b/src/rapidata/api_client/models/get_prompt_embedding_map_endpoint_output.py index e9951a4c0d..56cc0bb3bb 100644 --- a/src/rapidata/api_client/models/get_prompt_embedding_map_endpoint_output.py +++ b/src/rapidata/api_client/models/get_prompt_embedding_map_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_prompt_embedding_map_endpoint_output_point.py b/src/rapidata/api_client/models/get_prompt_embedding_map_endpoint_output_point.py index 04dfe3d39e..cb3e18e1ab 100644 --- a/src/rapidata/api_client/models/get_prompt_embedding_map_endpoint_output_point.py +++ b/src/rapidata/api_client/models/get_prompt_embedding_map_endpoint_output_point.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_prompt_embedding_map_status_endpoint_output.py b/src/rapidata/api_client/models/get_prompt_embedding_map_status_endpoint_output.py index 0f6f9818f6..2131c0b28e 100644 --- a/src/rapidata/api_client/models/get_prompt_embedding_map_status_endpoint_output.py +++ b/src/rapidata/api_client/models/get_prompt_embedding_map_status_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_prompts_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/get_prompts_by_benchmark_endpoint_output.py index 1d9d439984..096584216d 100644 --- a/src/rapidata/api_client/models/get_prompts_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/get_prompts_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_prompts_by_benchmark_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/get_prompts_by_benchmark_endpoint_paged_result_of_output.py index 635ce89edd..0ac4b415fb 100644 --- a/src/rapidata/api_client/models/get_prompts_by_benchmark_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_prompts_by_benchmark_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_public_orders_endpoint_order_output.py b/src/rapidata/api_client/models/get_public_orders_endpoint_order_output.py index 32489d5ef3..0b07a20f61 100644 --- a/src/rapidata/api_client/models/get_public_orders_endpoint_order_output.py +++ b/src/rapidata/api_client/models/get_public_orders_endpoint_order_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_public_orders_endpoint_output.py b/src/rapidata/api_client/models/get_public_orders_endpoint_output.py index 8e316b2a9c..e4676d9635 100644 --- a/src/rapidata/api_client/models/get_public_orders_endpoint_output.py +++ b/src/rapidata/api_client/models/get_public_orders_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_ranking_flow_item_results_endpoint_output.py b/src/rapidata/api_client/models/get_ranking_flow_item_results_endpoint_output.py index cf4c768e37..94fe09521d 100644 --- a/src/rapidata/api_client/models/get_ranking_flow_item_results_endpoint_output.py +++ b/src/rapidata/api_client/models/get_ranking_flow_item_results_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_ranking_flow_item_results_endpoint_output_datapoint.py b/src/rapidata/api_client/models/get_ranking_flow_item_results_endpoint_output_datapoint.py index 84d174ef10..466a1fe992 100644 --- a/src/rapidata/api_client/models/get_ranking_flow_item_results_endpoint_output_datapoint.py +++ b/src/rapidata/api_client/models/get_ranking_flow_item_results_endpoint_output_datapoint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_ranking_flow_item_vote_matrix_endpoint_output.py b/src/rapidata/api_client/models/get_ranking_flow_item_vote_matrix_endpoint_output.py index 6ad5f64360..0a35d0bbdc 100644 --- a/src/rapidata/api_client/models/get_ranking_flow_item_vote_matrix_endpoint_output.py +++ b/src/rapidata/api_client/models/get_ranking_flow_item_vote_matrix_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_ranking_workflow_results_model.py b/src/rapidata/api_client/models/get_ranking_workflow_results_model.py deleted file mode 100644 index c9a977e812..0000000000 --- a/src/rapidata/api_client/models/get_ranking_workflow_results_model.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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 -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.pagination import Pagination -from rapidata.api_client.models.sort_criteria import SortCriteria -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetRankingWorkflowResultsModel(LazyValidatedModel): - """ - Model for getting the overview of a ranking workflow result. - """ # noqa: E501 - page: Optional[Pagination] = Field(default=None, description="The size of the page and the page number to display.") - sort_criteria: Optional[SortCriteria] = Field(default=None, description="A list of criteria to sort the results by.", alias="sortCriteria") - __properties: ClassVar[List[str]] = ["page", "sortCriteria"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetRankingWorkflowResultsModel 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 page - if self.page: - _dict['page'] = self.page.to_dict() - # override the default output from pydantic by calling `to_dict()` of sort_criteria - if self.sort_criteria: - _dict['sortCriteria'] = self.sort_criteria.to_dict() - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetRankingWorkflowResultsModel from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "page": Pagination.from_dict(obj["page"]) if obj.get("page") is not None else None, - "sortCriteria": SortCriteria.from_dict(obj["sortCriteria"]) if obj.get("sortCriteria") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_ranking_workflow_results_result.py b/src/rapidata/api_client/models/get_ranking_workflow_results_result.py deleted file mode 100644 index 8d63df6762..0000000000 --- a/src/rapidata/api_client/models/get_ranking_workflow_results_result.py +++ /dev/null @@ -1,107 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictInt -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.get_ranking_workflow_results_result_datapoint import GetRankingWorkflowResultsResultDatapoint -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetRankingWorkflowResultsResult(LazyValidatedModel): - """ - GetRankingWorkflowResultsResult - """ # noqa: E501 - total_votes: StrictInt = Field(alias="totalVotes") - total: StrictInt - page: StrictInt - page_size: StrictInt = Field(alias="pageSize") - items: List[GetRankingWorkflowResultsResultDatapoint] - total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages") - __properties: ClassVar[List[str]] = ["totalVotes", "total", "page", "pageSize", "items", "totalPages"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetRankingWorkflowResultsResult 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 items (list) - _items = [] - if self.items: - for _item_items in self.items: - if _item_items: - _items.append(_item_items.to_dict()) - _dict['items'] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetRankingWorkflowResultsResult from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "totalVotes": obj.get("totalVotes"), - "total": obj.get("total"), - "page": obj.get("page"), - "pageSize": obj.get("pageSize"), - "items": [GetRankingWorkflowResultsResultDatapoint.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, - "totalPages": obj.get("totalPages") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_ranking_workflow_results_result_datapoint.py b/src/rapidata/api_client/models/get_ranking_workflow_results_result_datapoint.py deleted file mode 100644 index 3d8515844a..0000000000 --- a/src/rapidata/api_client/models/get_ranking_workflow_results_result_datapoint.py +++ /dev/null @@ -1,97 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List -from rapidata.api_client.models.i_asset_model import IAssetModel -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetRankingWorkflowResultsResultDatapoint(LazyValidatedModel): - """ - GetRankingWorkflowResultsResultDatapoint - """ # noqa: E501 - workflow_datapoint_id: StrictStr = Field(alias="workflowDatapointId") - asset: IAssetModel - elo: StrictInt - __properties: ClassVar[List[str]] = ["workflowDatapointId", "asset", "elo"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetRankingWorkflowResultsResultDatapoint 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 asset - if self.asset: - _dict['asset'] = self.asset.to_dict() - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetRankingWorkflowResultsResultDatapoint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "workflowDatapointId": obj.get("workflowDatapointId"), - "asset": IAssetModel.from_dict(obj["asset"]) if obj.get("asset") is not None else None, - "elo": obj.get("elo") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_rapid_navigation_endpoint_card.py b/src/rapidata/api_client/models/get_rapid_navigation_endpoint_card.py index 24812bc0a1..2a862e2882 100644 --- a/src/rapidata/api_client/models/get_rapid_navigation_endpoint_card.py +++ b/src/rapidata/api_client/models/get_rapid_navigation_endpoint_card.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_rapid_navigation_endpoint_card_response.py b/src/rapidata/api_client/models/get_rapid_navigation_endpoint_card_response.py index 0aefbbd295..1ddd1038a0 100644 --- a/src/rapidata/api_client/models/get_rapid_navigation_endpoint_card_response.py +++ b/src/rapidata/api_client/models/get_rapid_navigation_endpoint_card_response.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_rapid_navigation_endpoint_item.py b/src/rapidata/api_client/models/get_rapid_navigation_endpoint_item.py index 1a6611aa4e..8a69a8c4ad 100644 --- a/src/rapidata/api_client/models/get_rapid_navigation_endpoint_item.py +++ b/src/rapidata/api_client/models/get_rapid_navigation_endpoint_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_rapid_navigation_endpoint_output.py b/src/rapidata/api_client/models/get_rapid_navigation_endpoint_output.py index 24551a8bd1..b08e4a36ca 100644 --- a/src/rapidata/api_client/models/get_rapid_navigation_endpoint_output.py +++ b/src/rapidata/api_client/models/get_rapid_navigation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_recommended_validation_set_endpoint_output.py b/src/rapidata/api_client/models/get_recommended_validation_set_endpoint_output.py index 6fcdcbe769..1912898e34 100644 --- a/src/rapidata/api_client/models/get_recommended_validation_set_endpoint_output.py +++ b/src/rapidata/api_client/models/get_recommended_validation_set_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_recommended_validation_set_endpoint_validation_set_output.py b/src/rapidata/api_client/models/get_recommended_validation_set_endpoint_validation_set_output.py index 9fdbe08911..7501f69a32 100644 --- a/src/rapidata/api_client/models/get_recommended_validation_set_endpoint_validation_set_output.py +++ b/src/rapidata/api_client/models/get_recommended_validation_set_endpoint_validation_set_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_reconciliation_status_endpoint_output.py b/src/rapidata/api_client/models/get_reconciliation_status_endpoint_output.py index 330503b3b3..b447b1a7bd 100644 --- a/src/rapidata/api_client/models/get_reconciliation_status_endpoint_output.py +++ b/src/rapidata/api_client/models/get_reconciliation_status_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_replicate_model_endpoint_output.py b/src/rapidata/api_client/models/get_replicate_model_endpoint_output.py index c6e7d634b3..2123cc3dc1 100644 --- a/src/rapidata/api_client/models/get_replicate_model_endpoint_output.py +++ b/src/rapidata/api_client/models/get_replicate_model_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_replicate_model_endpoint_parameter.py b/src/rapidata/api_client/models/get_replicate_model_endpoint_parameter.py index adda407437..50d69e07ab 100644 --- a/src/rapidata/api_client/models/get_replicate_model_endpoint_parameter.py +++ b/src/rapidata/api_client/models/get_replicate_model_endpoint_parameter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_response_count_histogram_endpoint_output.py b/src/rapidata/api_client/models/get_response_count_histogram_endpoint_output.py index 6b47feae37..6d5a6d86fd 100644 --- a/src/rapidata/api_client/models/get_response_count_histogram_endpoint_output.py +++ b/src/rapidata/api_client/models/get_response_count_histogram_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_response_count_histogram_endpoint_output_bucket.py b/src/rapidata/api_client/models/get_response_count_histogram_endpoint_output_bucket.py index cebfc48ad6..c96918425e 100644 --- a/src/rapidata/api_client/models/get_response_count_histogram_endpoint_output_bucket.py +++ b/src/rapidata/api_client/models/get_response_count_histogram_endpoint_output_bucket.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_response_count_timeseries_endpoint_output.py b/src/rapidata/api_client/models/get_response_count_timeseries_endpoint_output.py index 304bc95c37..d3fc5ae030 100644 --- a/src/rapidata/api_client/models/get_response_count_timeseries_endpoint_output.py +++ b/src/rapidata/api_client/models/get_response_count_timeseries_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_response_count_timeseries_endpoint_output_data_point.py b/src/rapidata/api_client/models/get_response_count_timeseries_endpoint_output_data_point.py index abe13ee101..e1aa15d646 100644 --- a/src/rapidata/api_client/models/get_response_count_timeseries_endpoint_output_data_point.py +++ b/src/rapidata/api_client/models/get_response_count_timeseries_endpoint_output_data_point.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_responses_for_rapid_endpoint_output.py b/src/rapidata/api_client/models/get_responses_for_rapid_endpoint_output.py index 2c0214328f..1892e9b620 100644 --- a/src/rapidata/api_client/models/get_responses_for_rapid_endpoint_output.py +++ b/src/rapidata/api_client/models/get_responses_for_rapid_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_responses_for_rapid_endpoint_output_response.py b/src/rapidata/api_client/models/get_responses_for_rapid_endpoint_output_response.py index d7baea41d0..ed8911b258 100644 --- a/src/rapidata/api_client/models/get_responses_for_rapid_endpoint_output_response.py +++ b/src/rapidata/api_client/models/get_responses_for_rapid_endpoint_output_response.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_sample_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_sample_by_id_endpoint_output.py index 99d995ab2e..17c2326b86 100644 --- a/src/rapidata/api_client/models/get_sample_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_sample_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_sample_generation_endpoint_output.py b/src/rapidata/api_client/models/get_sample_generation_endpoint_output.py index ec1b48efac..8effa32f59 100644 --- a/src/rapidata/api_client/models/get_sample_generation_endpoint_output.py +++ b/src/rapidata/api_client/models/get_sample_generation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_sample_generation_endpoint_output_participant.py b/src/rapidata/api_client/models/get_sample_generation_endpoint_output_participant.py index f888509611..c67f186bc0 100644 --- a/src/rapidata/api_client/models/get_sample_generation_endpoint_output_participant.py +++ b/src/rapidata/api_client/models/get_sample_generation_endpoint_output_participant.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_sample_generation_items_endpoint_output.py b/src/rapidata/api_client/models/get_sample_generation_items_endpoint_output.py index 0624fbd788..8b2ce70198 100644 --- a/src/rapidata/api_client/models/get_sample_generation_items_endpoint_output.py +++ b/src/rapidata/api_client/models/get_sample_generation_items_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_sample_generation_items_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/get_sample_generation_items_endpoint_paged_result_of_output.py index 4fdbf14635..8fa35376cd 100644 --- a/src/rapidata/api_client/models/get_sample_generation_items_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_sample_generation_items_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_sample_navigation_endpoint_output.py b/src/rapidata/api_client/models/get_sample_navigation_endpoint_output.py index cb702e8291..e35eafa8d1 100644 --- a/src/rapidata/api_client/models/get_sample_navigation_endpoint_output.py +++ b/src/rapidata/api_client/models/get_sample_navigation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_sample_navigation_endpoint_sample.py b/src/rapidata/api_client/models/get_sample_navigation_endpoint_sample.py index f68dd0d824..9a2df9e8dc 100644 --- a/src/rapidata/api_client/models/get_sample_navigation_endpoint_sample.py +++ b/src/rapidata/api_client/models/get_sample_navigation_endpoint_sample.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_samples_by_identifier_endpoint_output.py b/src/rapidata/api_client/models/get_samples_by_identifier_endpoint_output.py index 9051ab1599..291170b8f7 100644 --- a/src/rapidata/api_client/models/get_samples_by_identifier_endpoint_output.py +++ b/src/rapidata/api_client/models/get_samples_by_identifier_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_samples_by_identifier_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/get_samples_by_identifier_endpoint_paged_result_of_output.py index 3feeebbe1e..9ac6cee457 100644 --- a/src/rapidata/api_client/models/get_samples_by_identifier_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_samples_by_identifier_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output.py b/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output.py index 176da072cd..2dffaab764 100644 --- a/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output.py +++ b/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output_get_samples_by_participant_endpoint_placeholder_sample_output.py b/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output_get_samples_by_participant_endpoint_placeholder_sample_output.py index 5972154ca1..e15f8c96b7 100644 --- a/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output_get_samples_by_participant_endpoint_placeholder_sample_output.py +++ b/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output_get_samples_by_participant_endpoint_placeholder_sample_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output_get_samples_by_participant_endpoint_sample_output.py b/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output_get_samples_by_participant_endpoint_sample_output.py index 3a6002ae2f..f40d7c5498 100644 --- a/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output_get_samples_by_participant_endpoint_sample_output.py +++ b/src/rapidata/api_client/models/get_samples_by_participant_endpoint_i_sample_output_get_samples_by_participant_endpoint_sample_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_samples_by_participant_endpoint_paged_result_of_i_sample_output.py b/src/rapidata/api_client/models/get_samples_by_participant_endpoint_paged_result_of_i_sample_output.py index b283178949..6738ac1d7e 100644 --- a/src/rapidata/api_client/models/get_samples_by_participant_endpoint_paged_result_of_i_sample_output.py +++ b/src/rapidata/api_client/models/get_samples_by_participant_endpoint_paged_result_of_i_sample_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_signal_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_signal_by_id_endpoint_output.py index d5c9952765..2f2cd18529 100644 --- a/src/rapidata/api_client/models/get_signal_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_signal_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_signal_run_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_signal_run_by_id_endpoint_output.py index 9b1a7171ab..61c15a223e 100644 --- a/src/rapidata/api_client/models/get_signal_run_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_signal_run_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_simple_workflow_results_endpoint_output.py b/src/rapidata/api_client/models/get_simple_workflow_results_endpoint_output.py deleted file mode 100644 index 6995e62124..0000000000 --- a/src/rapidata/api_client/models/get_simple_workflow_results_endpoint_output.py +++ /dev/null @@ -1,140 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictFloat, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union -from rapidata.api_client.models.get_simple_workflow_results_endpoint_response_output import GetSimpleWorkflowResultsEndpointResponseOutput -from rapidata.api_client.models.i_asset import IAsset -from rapidata.api_client.models.i_rapid_payload import IRapidPayload -from rapidata.api_client.models.i_response_aggregation import IResponseAggregation -from rapidata.api_client.models.rapid_state import RapidState -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetSimpleWorkflowResultsEndpointOutput(LazyValidatedModel): - """ - GetSimpleWorkflowResultsEndpointOutput - """ # noqa: E501 - rapid_id: StrictStr = Field(description="The id of the rapid.", alias="rapidId") - payload: IRapidPayload = Field(description="The payload of the rapid.") - asset: IAsset = Field(description="The asset of the rapid.") - responses: List[GetSimpleWorkflowResultsEndpointResponseOutput] - total_response_count: StrictInt = Field(description="The true number of matching responses for this rapid, regardless of whether the returned Responses list was capped.", alias="totalResponseCount") - state: RapidState = Field(description="The state of the rapid.") - context: Optional[StrictStr] = Field(default=None, description="The optional textual context of the rapid.") - context_asset: Optional[IAsset] = Field(default=None, description="The optional asset shown as context to the user.", alias="contextAsset") - decisiveness: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The decisiveness of the rapid.") - aggregation: Optional[IResponseAggregation] = Field(default=None, description="Per-payload-type aggregation over all matching responses (computed before sampling). Populated for Compare and Classify rapids; null otherwise.") - __properties: ClassVar[List[str]] = ["rapidId", "payload", "asset", "responses", "totalResponseCount", "state", "context", "contextAsset", "decisiveness", "aggregation"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetSimpleWorkflowResultsEndpointOutput 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 payload - if self.payload: - _dict['payload'] = self.payload.to_dict() - # override the default output from pydantic by calling `to_dict()` of asset - if self.asset: - _dict['asset'] = self.asset.to_dict() - # override the default output from pydantic by calling `to_dict()` of each item in responses (list) - _items = [] - if self.responses: - for _item_responses in self.responses: - if _item_responses: - _items.append(_item_responses.to_dict()) - _dict['responses'] = _items - # override the default output from pydantic by calling `to_dict()` of context_asset - if self.context_asset: - _dict['contextAsset'] = self.context_asset.to_dict() - # override the default output from pydantic by calling `to_dict()` of aggregation - if self.aggregation: - _dict['aggregation'] = self.aggregation.to_dict() - # set to None if context (nullable) is None - # and model_fields_set contains the field - if self.context is None and "context" in self.model_fields_set: - _dict['context'] = None - - # set to None if decisiveness (nullable) is None - # and model_fields_set contains the field - if self.decisiveness is None and "decisiveness" in self.model_fields_set: - _dict['decisiveness'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetSimpleWorkflowResultsEndpointOutput from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "rapidId": obj.get("rapidId"), - "payload": IRapidPayload.from_dict(obj["payload"]) if obj.get("payload") is not None else None, - "asset": IAsset.from_dict(obj["asset"]) if obj.get("asset") is not None else None, - "responses": [GetSimpleWorkflowResultsEndpointResponseOutput.from_dict(_item) for _item in obj["responses"]] if obj.get("responses") is not None else None, - "totalResponseCount": obj.get("totalResponseCount"), - "state": obj.get("state"), - "context": obj.get("context"), - "contextAsset": IAsset.from_dict(obj["contextAsset"]) if obj.get("contextAsset") is not None else None, - "decisiveness": obj.get("decisiveness"), - "aggregation": IResponseAggregation.from_dict(obj["aggregation"]) if obj.get("aggregation") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_simple_workflow_results_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/get_simple_workflow_results_endpoint_paged_result_of_output.py deleted file mode 100644 index a02834726c..0000000000 --- a/src/rapidata/api_client/models/get_simple_workflow_results_endpoint_paged_result_of_output.py +++ /dev/null @@ -1,104 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.get_simple_workflow_results_endpoint_output import GetSimpleWorkflowResultsEndpointOutput -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetSimpleWorkflowResultsEndpointPagedResultOfOutput(LazyValidatedModel): - """ - GetSimpleWorkflowResultsEndpointPagedResultOfOutput - """ # noqa: E501 - total: StrictInt - page: StrictInt - page_size: StrictInt = Field(alias="pageSize") - items: List[GetSimpleWorkflowResultsEndpointOutput] - total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages") - __properties: ClassVar[List[str]] = ["total", "page", "pageSize", "items", "totalPages"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetSimpleWorkflowResultsEndpointPagedResultOfOutput 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 items (list) - _items = [] - if self.items: - for _item_items in self.items: - if _item_items: - _items.append(_item_items.to_dict()) - _dict['items'] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetSimpleWorkflowResultsEndpointPagedResultOfOutput from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "total": obj.get("total"), - "page": obj.get("page"), - "pageSize": obj.get("pageSize"), - "items": [GetSimpleWorkflowResultsEndpointOutput.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, - "totalPages": obj.get("totalPages") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_simple_workflow_results_endpoint_response_output.py b/src/rapidata/api_client/models/get_simple_workflow_results_endpoint_response_output.py deleted file mode 100644 index 5a1de4951e..0000000000 --- a/src/rapidata/api_client/models/get_simple_workflow_results_endpoint_response_output.py +++ /dev/null @@ -1,127 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictFloat, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union -from rapidata.api_client.models.i_rapid_result import IRapidResult -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetSimpleWorkflowResultsEndpointResponseOutput(LazyValidatedModel): - """ - GetSimpleWorkflowResultsEndpointResponseOutput - """ # noqa: E501 - id: StrictStr - user_id: StrictStr = Field(alias="userId") - country: StrictStr - language: StrictStr - age: Optional[StrictStr] - gender: Optional[StrictStr] - occupation: Optional[StrictStr] - demographic_information: Dict[str, StrictStr] = Field(alias="demographicInformation") - result: IRapidResult - user_score: Union[StrictFloat, StrictInt] = Field(alias="userScore") - user_scores: Dict[str, Union[StrictFloat, StrictInt]] = Field(alias="userScores") - __properties: ClassVar[List[str]] = ["id", "userId", "country", "language", "age", "gender", "occupation", "demographicInformation", "result", "userScore", "userScores"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetSimpleWorkflowResultsEndpointResponseOutput 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 result - if self.result: - _dict['result'] = self.result.to_dict() - # set to None if age (nullable) is None - # and model_fields_set contains the field - if self.age is None and "age" in self.model_fields_set: - _dict['age'] = None - - # set to None if gender (nullable) is None - # and model_fields_set contains the field - if self.gender is None and "gender" in self.model_fields_set: - _dict['gender'] = None - - # set to None if occupation (nullable) is None - # and model_fields_set contains the field - if self.occupation is None and "occupation" in self.model_fields_set: - _dict['occupation'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetSimpleWorkflowResultsEndpointResponseOutput from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "id": obj.get("id"), - "userId": obj.get("userId"), - "country": obj.get("country"), - "language": obj.get("language"), - "age": obj.get("age"), - "gender": obj.get("gender"), - "occupation": obj.get("occupation"), - "demographicInformation": obj.get("demographicInformation"), - "result": IRapidResult.from_dict(obj["result"]) if obj.get("result") is not None else None, - "userScore": obj.get("userScore"), - "userScores": obj.get("userScores") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_user_score_cache_endpoint_output.py b/src/rapidata/api_client/models/get_user_score_cache_endpoint_output.py index b05547e60b..c2a2c703cc 100644 --- a/src/rapidata/api_client/models/get_user_score_cache_endpoint_output.py +++ b/src/rapidata/api_client/models/get_user_score_cache_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_validation_rapids_endpoint_output.py b/src/rapidata/api_client/models/get_validation_rapids_endpoint_output.py index 1bd7c30cb5..a771f8c585 100644 --- a/src/rapidata/api_client/models/get_validation_rapids_endpoint_output.py +++ b/src/rapidata/api_client/models/get_validation_rapids_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_validation_rapids_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/get_validation_rapids_endpoint_paged_result_of_output.py index ec5939c563..e652d97d77 100644 --- a/src/rapidata/api_client/models/get_validation_rapids_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/get_validation_rapids_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_validation_set_by_id_endpoint_output.py b/src/rapidata/api_client/models/get_validation_set_by_id_endpoint_output.py index d72c1c69f0..8bfd7afeba 100644 --- a/src/rapidata/api_client/models/get_validation_set_by_id_endpoint_output.py +++ b/src/rapidata/api_client/models/get_validation_set_by_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_volume_discounts_endpoint_output.py b/src/rapidata/api_client/models/get_volume_discounts_endpoint_output.py index 498ae1fd0e..e6fb41b671 100644 --- a/src/rapidata/api_client/models/get_volume_discounts_endpoint_output.py +++ b/src/rapidata/api_client/models/get_volume_discounts_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_volume_discounts_endpoint_output_volume_discount_item.py b/src/rapidata/api_client/models/get_volume_discounts_endpoint_output_volume_discount_item.py index 26361e79e0..7b32930eda 100644 --- a/src/rapidata/api_client/models/get_volume_discounts_endpoint_output_volume_discount_item.py +++ b/src/rapidata/api_client/models/get_volume_discounts_endpoint_output_volume_discount_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/get_workflow_progress_endpoint_output.py b/src/rapidata/api_client/models/get_workflow_progress_endpoint_output.py deleted file mode 100644 index cc73cd4bc0..0000000000 --- a/src/rapidata/api_client/models/get_workflow_progress_endpoint_output.py +++ /dev/null @@ -1,95 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictFloat, StrictInt -from typing import Any, ClassVar, Dict, List, Union -from rapidata.api_client.models.workflow_state import WorkflowState -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetWorkflowProgressEndpointOutput(LazyValidatedModel): - """ - GetWorkflowProgressEndpointOutput - """ # noqa: E501 - completion_percentage: Union[StrictFloat, StrictInt] = Field(description="The percentage of workflow datapoints that have been completed.", alias="completionPercentage") - total: StrictInt = Field(description="The total number of datapoints in the workflow.") - completed: StrictInt = Field(description="The number of datapoints that have been completed.") - state: WorkflowState = Field(description="The current state of the workflow.") - __properties: ClassVar[List[str]] = ["completionPercentage", "total", "completed", "state"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetWorkflowProgressEndpointOutput 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 GetWorkflowProgressEndpointOutput from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "completionPercentage": obj.get("completionPercentage"), - "total": obj.get("total"), - "completed": obj.get("completed"), - "state": obj.get("state") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_workflow_results_result.py b/src/rapidata/api_client/models/get_workflow_results_result.py deleted file mode 100644 index 40eb9de85b..0000000000 --- a/src/rapidata/api_client/models/get_workflow_results_result.py +++ /dev/null @@ -1,133 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictFloat, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union -from rapidata.api_client.models.get_workflow_results_result_response import GetWorkflowResultsResultResponse -from rapidata.api_client.models.i_asset_model import IAssetModel -from rapidata.api_client.models.i_rapid_payload import IRapidPayload -from rapidata.api_client.models.rapid_state import RapidState -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetWorkflowResultsResult(LazyValidatedModel): - """ - GetWorkflowResultsResult - """ # noqa: E501 - rapid_id: StrictStr = Field(alias="rapidId") - payload: IRapidPayload - asset: IAssetModel - responses: List[GetWorkflowResultsResultResponse] - state: RapidState - context: Optional[StrictStr] = None - context_asset: Optional[IAssetModel] = Field(default=None, alias="contextAsset") - decisiveness: Optional[Union[StrictFloat, StrictInt]] = None - __properties: ClassVar[List[str]] = ["rapidId", "payload", "asset", "responses", "state", "context", "contextAsset", "decisiveness"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetWorkflowResultsResult 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 payload - if self.payload: - _dict['payload'] = self.payload.to_dict() - # override the default output from pydantic by calling `to_dict()` of asset - if self.asset: - _dict['asset'] = self.asset.to_dict() - # override the default output from pydantic by calling `to_dict()` of each item in responses (list) - _items = [] - if self.responses: - for _item_responses in self.responses: - if _item_responses: - _items.append(_item_responses.to_dict()) - _dict['responses'] = _items - # override the default output from pydantic by calling `to_dict()` of context_asset - if self.context_asset: - _dict['contextAsset'] = self.context_asset.to_dict() - # set to None if context (nullable) is None - # and model_fields_set contains the field - if self.context is None and "context" in self.model_fields_set: - _dict['context'] = None - - # set to None if context_asset (nullable) is None - # and model_fields_set contains the field - if self.context_asset is None and "context_asset" in self.model_fields_set: - _dict['contextAsset'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetWorkflowResultsResult from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "rapidId": obj.get("rapidId"), - "payload": IRapidPayload.from_dict(obj["payload"]) if obj.get("payload") is not None else None, - "asset": IAssetModel.from_dict(obj["asset"]) if obj.get("asset") is not None else None, - "responses": [GetWorkflowResultsResultResponse.from_dict(_item) for _item in obj["responses"]] if obj.get("responses") is not None else None, - "state": obj.get("state"), - "context": obj.get("context"), - "contextAsset": IAssetModel.from_dict(obj["contextAsset"]) if obj.get("contextAsset") is not None else None, - "decisiveness": obj.get("decisiveness") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/get_workflow_results_result_response.py b/src/rapidata/api_client/models/get_workflow_results_result_response.py deleted file mode 100644 index 0a49fcb394..0000000000 --- a/src/rapidata/api_client/models/get_workflow_results_result_response.py +++ /dev/null @@ -1,106 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictFloat, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Union -from rapidata.api_client.models.i_rapid_result import IRapidResult -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class GetWorkflowResultsResultResponse(LazyValidatedModel): - """ - GetWorkflowResultsResultResponse - """ # noqa: E501 - id: StrictStr - user_id: StrictStr = Field(alias="userId") - country: StrictStr - language: StrictStr - result: IRapidResult - user_score: Union[StrictFloat, StrictInt] = Field(alias="userScore") - user_scores: Dict[str, Union[StrictFloat, StrictInt]] = Field(alias="userScores") - demographic_information: Dict[str, StrictStr] = Field(alias="demographicInformation") - __properties: ClassVar[List[str]] = ["id", "userId", "country", "language", "result", "userScore", "userScores", "demographicInformation"] - - # model_config is inherited from LazyValidatedModel - - - 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 GetWorkflowResultsResultResponse 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 result - if self.result: - _dict['result'] = self.result.to_dict() - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GetWorkflowResultsResultResponse from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "id": obj.get("id"), - "userId": obj.get("userId"), - "country": obj.get("country"), - "language": obj.get("language"), - "result": IRapidResult.from_dict(obj["result"]) if obj.get("result") is not None else None, - "userScore": obj.get("userScore"), - "userScores": obj.get("userScores"), - "demographicInformation": obj.get("demographicInformation") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/google_one_tap_login_endpoint_input.py b/src/rapidata/api_client/models/google_one_tap_login_endpoint_input.py index 62de221c01..7104b8aae0 100644 --- a/src/rapidata/api_client/models/google_one_tap_login_endpoint_input.py +++ b/src/rapidata/api_client/models/google_one_tap_login_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/google_one_tap_login_endpoint_output.py b/src/rapidata/api_client/models/google_one_tap_login_endpoint_output.py index 3721af5465..0a6c4696cd 100644 --- a/src/rapidata/api_client/models/google_one_tap_login_endpoint_output.py +++ b/src/rapidata/api_client/models/google_one_tap_login_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/grant_bidder_relation_endpoint_input.py b/src/rapidata/api_client/models/grant_bidder_relation_endpoint_input.py index 902e41f8ee..3e1d408b99 100644 --- a/src/rapidata/api_client/models/grant_bidder_relation_endpoint_input.py +++ b/src/rapidata/api_client/models/grant_bidder_relation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/grant_external_app_relation_endpoint_input.py b/src/rapidata/api_client/models/grant_external_app_relation_endpoint_input.py index 94eb85626c..c72f7d2a0e 100644 --- a/src/rapidata/api_client/models/grant_external_app_relation_endpoint_input.py +++ b/src/rapidata/api_client/models/grant_external_app_relation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/grant_platform_relation_endpoint_input.py b/src/rapidata/api_client/models/grant_platform_relation_endpoint_input.py index 5d76843fe9..9c4eb6bb6f 100644 --- a/src/rapidata/api_client/models/grant_platform_relation_endpoint_input.py +++ b/src/rapidata/api_client/models/grant_platform_relation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/grant_voucher_endpoint_input.py b/src/rapidata/api_client/models/grant_voucher_endpoint_input.py index 13d7828107..b080d670e3 100644 --- a/src/rapidata/api_client/models/grant_voucher_endpoint_input.py +++ b/src/rapidata/api_client/models/grant_voucher_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/grant_voucher_endpoint_output.py b/src/rapidata/api_client/models/grant_voucher_endpoint_output.py index aac6d5738c..c5468dac92 100644 --- a/src/rapidata/api_client/models/grant_voucher_endpoint_output.py +++ b/src/rapidata/api_client/models/grant_voucher_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/grouped_ranking_group.py b/src/rapidata/api_client/models/grouped_ranking_group.py index cdfc662414..e2b6c134ac 100644 --- a/src/rapidata/api_client/models/grouped_ranking_group.py +++ b/src/rapidata/api_client/models/grouped_ranking_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/hugging_face_sync_outcome.py b/src/rapidata/api_client/models/hugging_face_sync_outcome.py index 9f7c70ba2a..dcf761cdd2 100644 --- a/src/rapidata/api_client/models/hugging_face_sync_outcome.py +++ b/src/rapidata/api_client/models/hugging_face_sync_outcome.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/hugging_face_sync_status.py b/src/rapidata/api_client/models/hugging_face_sync_status.py index af58dc6bf5..57f64ef039 100644 --- a/src/rapidata/api_client/models/hugging_face_sync_status.py +++ b/src/rapidata/api_client/models/hugging_face_sync_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_artifact.py b/src/rapidata/api_client/models/i_artifact.py deleted file mode 100644 index a2f87f4ec6..0000000000 --- a/src/rapidata/api_client/models/i_artifact.py +++ /dev/null @@ -1,179 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -from __future__ import annotations -import json -import pprint -from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator -from typing import Any, List, Optional -from rapidata.api_client.models.i_artifact_campaign_artifact import IArtifactCampaignArtifact -from rapidata.api_client.models.i_artifact_dataset_artifact import IArtifactDatasetArtifact -from rapidata.api_client.models.i_artifact_file_artifact import IArtifactFileArtifact -from rapidata.api_client.models.i_artifact_workflow_artifact import IArtifactWorkflowArtifact -from rapidata.api_client.models.i_artifact_workflow_config_artifact import IArtifactWorkflowConfigArtifact -from pydantic import StrictStr, Field -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Union, List, Set, Optional, Dict -from typing_extensions import Literal, Self - -IARTIFACT_ONE_OF_SCHEMAS = ["IArtifactCampaignArtifact", "IArtifactDatasetArtifact", "IArtifactFileArtifact", "IArtifactWorkflowArtifact", "IArtifactWorkflowConfigArtifact"] - -class IArtifact(LazyValidatedModel): - """ - IArtifact - """ - # data type: IArtifactCampaignArtifact - oneof_schema_1_validator: Optional[IArtifactCampaignArtifact] = None - # data type: IArtifactDatasetArtifact - oneof_schema_2_validator: Optional[IArtifactDatasetArtifact] = None - # data type: IArtifactFileArtifact - oneof_schema_3_validator: Optional[IArtifactFileArtifact] = None - # data type: IArtifactWorkflowArtifact - oneof_schema_4_validator: Optional[IArtifactWorkflowArtifact] = None - # data type: IArtifactWorkflowConfigArtifact - oneof_schema_5_validator: Optional[IArtifactWorkflowConfigArtifact] = None - actual_instance: Optional[Union[IArtifactCampaignArtifact, IArtifactDatasetArtifact, IArtifactFileArtifact, IArtifactWorkflowArtifact, IArtifactWorkflowConfigArtifact]] = None - one_of_schemas: Set[str] = { "IArtifactCampaignArtifact", "IArtifactDatasetArtifact", "IArtifactFileArtifact", "IArtifactWorkflowArtifact", "IArtifactWorkflowConfigArtifact" } - - # model_config is inherited from LazyValidatedModel - - - discriminator_value_class_map: Dict[str, str] = { - } - - def __init__(self, *args, **kwargs) -> None: - if args: - if len(args) > 1: - raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") - if kwargs: - raise ValueError("If a position argument is used, keyword arguments cannot be used.") - super().__init__(actual_instance=args[0]) - else: - super().__init__(**kwargs) - - @field_validator('actual_instance') - def actual_instance_must_validate_oneof(cls, v): - instance = IArtifact.model_construct() - error_messages = [] - match = 0 - # validate data type: IArtifactCampaignArtifact - if not isinstance(v, IArtifactCampaignArtifact): - error_messages.append(f"Error! Input type `{type(v)}` is not `IArtifactCampaignArtifact`") - else: - match += 1 - # validate data type: IArtifactDatasetArtifact - if not isinstance(v, IArtifactDatasetArtifact): - error_messages.append(f"Error! Input type `{type(v)}` is not `IArtifactDatasetArtifact`") - else: - match += 1 - # validate data type: IArtifactFileArtifact - if not isinstance(v, IArtifactFileArtifact): - error_messages.append(f"Error! Input type `{type(v)}` is not `IArtifactFileArtifact`") - else: - match += 1 - # validate data type: IArtifactWorkflowArtifact - if not isinstance(v, IArtifactWorkflowArtifact): - error_messages.append(f"Error! Input type `{type(v)}` is not `IArtifactWorkflowArtifact`") - else: - match += 1 - # validate data type: IArtifactWorkflowConfigArtifact - if not isinstance(v, IArtifactWorkflowConfigArtifact): - error_messages.append(f"Error! Input type `{type(v)}` is not `IArtifactWorkflowConfigArtifact`") - else: - match += 1 - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in IArtifact with oneOf schemas: IArtifactCampaignArtifact, IArtifactDatasetArtifact, IArtifactFileArtifact, IArtifactWorkflowArtifact, IArtifactWorkflowConfigArtifact. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when setting `actual_instance` in IArtifact with oneOf schemas: IArtifactCampaignArtifact, IArtifactDatasetArtifact, IArtifactFileArtifact, IArtifactWorkflowArtifact, IArtifactWorkflowConfigArtifact. Details: " + ", ".join(error_messages)) - else: - return v - - @classmethod - def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: - return cls.from_json(json.dumps(obj)) - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Returns the object represented by the json string""" - instance = cls.model_construct() - error_messages = [] - match = 0 - - # deserialize data into IArtifactCampaignArtifact - try: - instance.actual_instance = IArtifactCampaignArtifact.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IArtifactDatasetArtifact - try: - instance.actual_instance = IArtifactDatasetArtifact.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IArtifactFileArtifact - try: - instance.actual_instance = IArtifactFileArtifact.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IArtifactWorkflowArtifact - try: - instance.actual_instance = IArtifactWorkflowArtifact.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IArtifactWorkflowConfigArtifact - try: - instance.actual_instance = IArtifactWorkflowConfigArtifact.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into IArtifact with oneOf schemas: IArtifactCampaignArtifact, IArtifactDatasetArtifact, IArtifactFileArtifact, IArtifactWorkflowArtifact, IArtifactWorkflowConfigArtifact. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when deserializing the JSON string into IArtifact with oneOf schemas: IArtifactCampaignArtifact, IArtifactDatasetArtifact, IArtifactFileArtifact, IArtifactWorkflowArtifact, IArtifactWorkflowConfigArtifact. Details: " + ", ".join(error_messages)) - else: - return instance - - def to_json(self) -> str: - """Returns the JSON representation of the actual instance""" - if self.actual_instance is None: - return "null" - - if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): - return self.actual_instance.to_json() - else: - return json.dumps(self.actual_instance) - - def to_dict(self) -> Optional[Union[Dict[str, Any], IArtifactCampaignArtifact, IArtifactDatasetArtifact, IArtifactFileArtifact, IArtifactWorkflowArtifact, IArtifactWorkflowConfigArtifact]]: - """Returns the dict representation of the actual instance""" - if self.actual_instance is None: - return None - - if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): - return self.actual_instance.to_dict() - else: - # primitive type - return self.actual_instance - - def to_str(self) -> str: - """Returns the string representation of the actual instance""" - return pprint.pformat(self.model_dump()) - - diff --git a/src/rapidata/api_client/models/i_artifact_campaign_artifact.py b/src/rapidata/api_client/models/i_artifact_campaign_artifact.py deleted file mode 100644 index a569fcd8b2..0000000000 --- a/src/rapidata/api_client/models/i_artifact_campaign_artifact.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IArtifactCampaignArtifact(LazyValidatedModel): - """ - IArtifactCampaignArtifact - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - campaign_id: StrictStr = Field(alias="campaignId") - identifier: StrictStr - __properties: ClassVar[List[str]] = ["_t", "campaignId", "identifier"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['CampaignArtifactModel']): - raise ValueError("must be one of enum values ('CampaignArtifactModel')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IArtifactCampaignArtifact 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 IArtifactCampaignArtifact from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "campaignId": obj.get("campaignId"), - "identifier": obj.get("identifier") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_artifact_dataset_artifact.py b/src/rapidata/api_client/models/i_artifact_dataset_artifact.py deleted file mode 100644 index 4c5d218430..0000000000 --- a/src/rapidata/api_client/models/i_artifact_dataset_artifact.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IArtifactDatasetArtifact(LazyValidatedModel): - """ - IArtifactDatasetArtifact - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - dataset_id: StrictStr = Field(alias="datasetId") - identifier: StrictStr - __properties: ClassVar[List[str]] = ["_t", "datasetId", "identifier"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['DatasetArtifactModel']): - raise ValueError("must be one of enum values ('DatasetArtifactModel')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IArtifactDatasetArtifact 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 IArtifactDatasetArtifact from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "datasetId": obj.get("datasetId"), - "identifier": obj.get("identifier") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_artifact_file_artifact.py b/src/rapidata/api_client/models/i_artifact_file_artifact.py deleted file mode 100644 index ff8c5ae952..0000000000 --- a/src/rapidata/api_client/models/i_artifact_file_artifact.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IArtifactFileArtifact(LazyValidatedModel): - """ - IArtifactFileArtifact - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - file_name: StrictStr = Field(alias="fileName") - identifier: StrictStr - __properties: ClassVar[List[str]] = ["_t", "fileName", "identifier"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['FileArtifactModel']): - raise ValueError("must be one of enum values ('FileArtifactModel')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IArtifactFileArtifact 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 IArtifactFileArtifact from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "fileName": obj.get("fileName"), - "identifier": obj.get("identifier") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_artifact_workflow_artifact.py b/src/rapidata/api_client/models/i_artifact_workflow_artifact.py deleted file mode 100644 index fc2c4cd64a..0000000000 --- a/src/rapidata/api_client/models/i_artifact_workflow_artifact.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IArtifactWorkflowArtifact(LazyValidatedModel): - """ - IArtifactWorkflowArtifact - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - workflow_id: StrictStr = Field(alias="workflowId") - identifier: StrictStr - __properties: ClassVar[List[str]] = ["_t", "workflowId", "identifier"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['WorkflowArtifactModel']): - raise ValueError("must be one of enum values ('WorkflowArtifactModel')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IArtifactWorkflowArtifact 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 IArtifactWorkflowArtifact from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "workflowId": obj.get("workflowId"), - "identifier": obj.get("identifier") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_artifact_workflow_config_artifact.py b/src/rapidata/api_client/models/i_artifact_workflow_config_artifact.py deleted file mode 100644 index 3aec7e3e64..0000000000 --- a/src/rapidata/api_client/models/i_artifact_workflow_config_artifact.py +++ /dev/null @@ -1,103 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from rapidata.api_client.models.i_workflow_config import IWorkflowConfig -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IArtifactWorkflowConfigArtifact(LazyValidatedModel): - """ - IArtifactWorkflowConfigArtifact - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - workflow_config: IWorkflowConfig = Field(alias="workflowConfig") - identifier: StrictStr - __properties: ClassVar[List[str]] = ["_t", "workflowConfig", "identifier"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['WorkflowConfigArtifactModel']): - raise ValueError("must be one of enum values ('WorkflowConfigArtifactModel')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IArtifactWorkflowConfigArtifact 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 workflow_config - if self.workflow_config: - _dict['workflowConfig'] = self.workflow_config.to_dict() - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IArtifactWorkflowConfigArtifact from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "workflowConfig": IWorkflowConfig.from_dict(obj["workflowConfig"]) if obj.get("workflowConfig") is not None else None, - "identifier": obj.get("identifier") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_asset.py b/src/rapidata/api_client/models/i_asset.py index f3e636dbcf..553ed20be8 100644 --- a/src/rapidata/api_client/models/i_asset.py +++ b/src/rapidata/api_client/models/i_asset.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_asset_file_asset.py b/src/rapidata/api_client/models/i_asset_file_asset.py index 731a5be90f..5888e4605c 100644 --- a/src/rapidata/api_client/models/i_asset_file_asset.py +++ b/src/rapidata/api_client/models/i_asset_file_asset.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_asset_input.py b/src/rapidata/api_client/models/i_asset_input.py index d1069fa053..a535d2e3de 100644 --- a/src/rapidata/api_client/models/i_asset_input.py +++ b/src/rapidata/api_client/models/i_asset_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_asset_input_existing_asset_input.py b/src/rapidata/api_client/models/i_asset_input_existing_asset_input.py index cd8245e887..aa1446a04e 100644 --- a/src/rapidata/api_client/models/i_asset_input_existing_asset_input.py +++ b/src/rapidata/api_client/models/i_asset_input_existing_asset_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_asset_input_multi_asset_input.py b/src/rapidata/api_client/models/i_asset_input_multi_asset_input.py index 4aeaf8ff61..f95e4603fd 100644 --- a/src/rapidata/api_client/models/i_asset_input_multi_asset_input.py +++ b/src/rapidata/api_client/models/i_asset_input_multi_asset_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_asset_input_text_asset_input.py b/src/rapidata/api_client/models/i_asset_input_text_asset_input.py index dffb245830..fee8289852 100644 --- a/src/rapidata/api_client/models/i_asset_input_text_asset_input.py +++ b/src/rapidata/api_client/models/i_asset_input_text_asset_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_asset_multi_asset.py b/src/rapidata/api_client/models/i_asset_multi_asset.py index 785d415525..b9308a8546 100644 --- a/src/rapidata/api_client/models/i_asset_multi_asset.py +++ b/src/rapidata/api_client/models/i_asset_multi_asset.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_asset_null_asset.py b/src/rapidata/api_client/models/i_asset_null_asset.py index a3237651d4..1efa8a8bea 100644 --- a/src/rapidata/api_client/models/i_asset_null_asset.py +++ b/src/rapidata/api_client/models/i_asset_null_asset.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_asset_text_asset.py b/src/rapidata/api_client/models/i_asset_text_asset.py index 828ee0428a..dc86adfc2b 100644 --- a/src/rapidata/api_client/models/i_asset_text_asset.py +++ b/src/rapidata/api_client/models/i_asset_text_asset.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_audience_filter.py b/src/rapidata/api_client/models/i_audience_filter.py index a291e97d8e..656135ba7b 100644 --- a/src/rapidata/api_client/models/i_audience_filter.py +++ b/src/rapidata/api_client/models/i_audience_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_audience_filter_and_audience_filter.py b/src/rapidata/api_client/models/i_audience_filter_and_audience_filter.py index 0ae42722b7..d3cd3c3ebe 100644 --- a/src/rapidata/api_client/models/i_audience_filter_and_audience_filter.py +++ b/src/rapidata/api_client/models/i_audience_filter_and_audience_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_audience_filter_country_audience_filter.py b/src/rapidata/api_client/models/i_audience_filter_country_audience_filter.py index 32038a950b..ab32973792 100644 --- a/src/rapidata/api_client/models/i_audience_filter_country_audience_filter.py +++ b/src/rapidata/api_client/models/i_audience_filter_country_audience_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_audience_filter_demographic_audience_filter.py b/src/rapidata/api_client/models/i_audience_filter_demographic_audience_filter.py index 4a6f22eba7..621687bb96 100644 --- a/src/rapidata/api_client/models/i_audience_filter_demographic_audience_filter.py +++ b/src/rapidata/api_client/models/i_audience_filter_demographic_audience_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_audience_filter_device_audience_filter.py b/src/rapidata/api_client/models/i_audience_filter_device_audience_filter.py index 0b48caa0be..e3a7f47888 100644 --- a/src/rapidata/api_client/models/i_audience_filter_device_audience_filter.py +++ b/src/rapidata/api_client/models/i_audience_filter_device_audience_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_audience_filter_language_audience_filter.py b/src/rapidata/api_client/models/i_audience_filter_language_audience_filter.py index 6d0341d369..98a42175c7 100644 --- a/src/rapidata/api_client/models/i_audience_filter_language_audience_filter.py +++ b/src/rapidata/api_client/models/i_audience_filter_language_audience_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_audience_filter_not_audience_filter.py b/src/rapidata/api_client/models/i_audience_filter_not_audience_filter.py index 401e488082..86ffab32f6 100644 --- a/src/rapidata/api_client/models/i_audience_filter_not_audience_filter.py +++ b/src/rapidata/api_client/models/i_audience_filter_not_audience_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_audience_filter_or_audience_filter.py b/src/rapidata/api_client/models/i_audience_filter_or_audience_filter.py index d7f22be2d8..024494664c 100644 --- a/src/rapidata/api_client/models/i_audience_filter_or_audience_filter.py +++ b/src/rapidata/api_client/models/i_audience_filter_or_audience_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_billing_group.py b/src/rapidata/api_client/models/i_billing_group.py index cd9b74c917..1b5ff10591 100644 --- a/src/rapidata/api_client/models/i_billing_group.py +++ b/src/rapidata/api_client/models/i_billing_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_billing_group_audience_distillation_billing_group.py b/src/rapidata/api_client/models/i_billing_group_audience_distillation_billing_group.py index c3b49881b2..b377b2ed42 100644 --- a/src/rapidata/api_client/models/i_billing_group_audience_distillation_billing_group.py +++ b/src/rapidata/api_client/models/i_billing_group_audience_distillation_billing_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_billing_group_audience_job_billing_group.py b/src/rapidata/api_client/models/i_billing_group_audience_job_billing_group.py index 10af4f9050..e0196d4184 100644 --- a/src/rapidata/api_client/models/i_billing_group_audience_job_billing_group.py +++ b/src/rapidata/api_client/models/i_billing_group_audience_job_billing_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_billing_group_benchmark_billing_group.py b/src/rapidata/api_client/models/i_billing_group_benchmark_billing_group.py index 9cb24773a3..adf1a2db08 100644 --- a/src/rapidata/api_client/models/i_billing_group_benchmark_billing_group.py +++ b/src/rapidata/api_client/models/i_billing_group_benchmark_billing_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_billing_group_order_billing_group.py b/src/rapidata/api_client/models/i_billing_group_order_billing_group.py index 55291c6377..2c7ef3ad34 100644 --- a/src/rapidata/api_client/models/i_billing_group_order_billing_group.py +++ b/src/rapidata/api_client/models/i_billing_group_order_billing_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_billing_group_ranking_flow_billing_group.py b/src/rapidata/api_client/models/i_billing_group_ranking_flow_billing_group.py index 4e4223b715..05ab6a8f77 100644 --- a/src/rapidata/api_client/models/i_billing_group_ranking_flow_billing_group.py +++ b/src/rapidata/api_client/models/i_billing_group_ranking_flow_billing_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_billing_group_validation_set_billing_group.py b/src/rapidata/api_client/models/i_billing_group_validation_set_billing_group.py index 11798407fc..76e397c072 100644 --- a/src/rapidata/api_client/models/i_billing_group_validation_set_billing_group.py +++ b/src/rapidata/api_client/models/i_billing_group_validation_set_billing_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter.py b/src/rapidata/api_client/models/i_campaign_filter.py index dd49e681b9..42aab760ad 100644 --- a/src/rapidata/api_client/models/i_campaign_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_and_filter.py b/src/rapidata/api_client/models/i_campaign_filter_and_filter.py index 210fbe3662..6d0f831825 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_and_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_and_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_audience_state_filter.py b/src/rapidata/api_client/models/i_campaign_filter_audience_state_filter.py index f29a04bf4e..a39407acab 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_audience_state_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_audience_state_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_campaign_cooldown_filter.py b/src/rapidata/api_client/models/i_campaign_filter_campaign_cooldown_filter.py index 97976037ff..2039bd08c4 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_campaign_cooldown_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_campaign_cooldown_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_campaign_id_filter.py b/src/rapidata/api_client/models/i_campaign_filter_campaign_id_filter.py index ce6658cd0c..f013b8c8d5 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_campaign_id_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_campaign_id_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_campaign_session_count_filter.py b/src/rapidata/api_client/models/i_campaign_filter_campaign_session_count_filter.py index 35b8afd8df..3f10c99ea6 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_campaign_session_count_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_campaign_session_count_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_country_filter.py b/src/rapidata/api_client/models/i_campaign_filter_country_filter.py index 7820c39080..206a37f998 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_country_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_country_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_demographic_filter.py b/src/rapidata/api_client/models/i_campaign_filter_demographic_filter.py index 5165be970d..18ce345031 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_demographic_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_demographic_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_device_filter.py b/src/rapidata/api_client/models/i_campaign_filter_device_filter.py index e46e5dcd6c..7ef5c8c1f1 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_device_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_device_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_dsp_filter.py b/src/rapidata/api_client/models/i_campaign_filter_dsp_filter.py index 4ffdfa5d44..a535df77f3 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_dsp_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_dsp_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_language_filter.py b/src/rapidata/api_client/models/i_campaign_filter_language_filter.py index 34b6cfa3ef..196a9d71f4 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_language_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_language_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_new_user_filter.py b/src/rapidata/api_client/models/i_campaign_filter_new_user_filter.py index 5a10cf99e8..15444ad45a 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_new_user_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_new_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_not_filter.py b/src/rapidata/api_client/models/i_campaign_filter_not_filter.py index 228f3cf7ce..c1411e477a 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_not_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_not_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_or_filter.py b/src/rapidata/api_client/models/i_campaign_filter_or_filter.py index 79c1e3019c..e968cafc6c 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_or_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_or_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_response_count_filter.py b/src/rapidata/api_client/models/i_campaign_filter_response_count_filter.py index fa5ccfec86..53dad06dea 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_response_count_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_response_count_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_user_action_restriction_filter.py b/src/rapidata/api_client/models/i_campaign_filter_user_action_restriction_filter.py index 0b14efec18..9d68b38865 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_user_action_restriction_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_user_action_restriction_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_filter_user_score_filter.py b/src/rapidata/api_client/models/i_campaign_filter_user_score_filter.py index e8c4133cfe..2730e3ec06 100644 --- a/src/rapidata/api_client/models/i_campaign_filter_user_score_filter.py +++ b/src/rapidata/api_client/models/i_campaign_filter_user_score_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection.py b/src/rapidata/api_client/models/i_campaign_selection.py index 728f1e4280..b9823eed8b 100644 --- a/src/rapidata/api_client/models/i_campaign_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_ab_test_selection.py b/src/rapidata/api_client/models/i_campaign_selection_ab_test_selection.py index b02c4cc5c2..d574c4d0f9 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_ab_test_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_ab_test_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_audience_selection.py b/src/rapidata/api_client/models/i_campaign_selection_audience_selection.py index c11d22d607..67b375b4f1 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_audience_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_audience_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_capped_selection.py b/src/rapidata/api_client/models/i_campaign_selection_capped_selection.py index 1c98a49a05..9de314a95d 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_capped_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_capped_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_conditional_validation_selection.py b/src/rapidata/api_client/models/i_campaign_selection_conditional_validation_selection.py index 1d796be0a3..f25bef70f6 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_conditional_validation_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_conditional_validation_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_demographic_selection.py b/src/rapidata/api_client/models/i_campaign_selection_demographic_selection.py index c49be77b09..28eadc3246 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_demographic_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_demographic_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_enforcing_selection.py b/src/rapidata/api_client/models/i_campaign_selection_enforcing_selection.py index 018f615e14..1c67819a16 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_enforcing_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_enforcing_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_labeling_selection.py b/src/rapidata/api_client/models/i_campaign_selection_labeling_selection.py index 5698f541b2..79854e9452 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_labeling_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_labeling_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_shuffling_selection.py b/src/rapidata/api_client/models/i_campaign_selection_shuffling_selection.py index 4ebe190593..edf18438d3 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_shuffling_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_shuffling_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_static_selection.py b/src/rapidata/api_client/models/i_campaign_selection_static_selection.py index 37adc8d0f4..f56946f58c 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_static_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_static_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_campaign_selection_validation_selection.py b/src/rapidata/api_client/models/i_campaign_selection_validation_selection.py index 6c01032f61..cfb5ce96b8 100644 --- a/src/rapidata/api_client/models/i_campaign_selection_validation_selection.py +++ b/src/rapidata/api_client/models/i_campaign_selection_validation_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_cooldown_duration.py b/src/rapidata/api_client/models/i_cooldown_duration.py index 292f72b9e4..6a41f46ef6 100644 --- a/src/rapidata/api_client/models/i_cooldown_duration.py +++ b/src/rapidata/api_client/models/i_cooldown_duration.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_cooldown_duration_fixed_cooldown_duration.py b/src/rapidata/api_client/models/i_cooldown_duration_fixed_cooldown_duration.py index 0068132237..10a785cda9 100644 --- a/src/rapidata/api_client/models/i_cooldown_duration_fixed_cooldown_duration.py +++ b/src/rapidata/api_client/models/i_cooldown_duration_fixed_cooldown_duration.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_cooldown_duration_random_cooldown_duration.py b/src/rapidata/api_client/models/i_cooldown_duration_random_cooldown_duration.py index 03809499ea..2103628208 100644 --- a/src/rapidata/api_client/models/i_cooldown_duration_random_cooldown_duration.py +++ b/src/rapidata/api_client/models/i_cooldown_duration_random_cooldown_duration.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_dataset_clone_dataset.py b/src/rapidata/api_client/models/i_dataset_clone_dataset.py index ba8c8b2ce0..efb6198c70 100644 --- a/src/rapidata/api_client/models/i_dataset_clone_dataset.py +++ b/src/rapidata/api_client/models/i_dataset_clone_dataset.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_payload.py b/src/rapidata/api_client/models/i_example_payload.py index 80635491c2..ac45ea9eb4 100644 --- a/src/rapidata/api_client/models/i_example_payload.py +++ b/src/rapidata/api_client/models/i_example_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_payload_classify_example_payload.py b/src/rapidata/api_client/models/i_example_payload_classify_example_payload.py index b0ebce1230..4d647f27f3 100644 --- a/src/rapidata/api_client/models/i_example_payload_classify_example_payload.py +++ b/src/rapidata/api_client/models/i_example_payload_classify_example_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_payload_compare_example_payload.py b/src/rapidata/api_client/models/i_example_payload_compare_example_payload.py index f333081063..800b23905b 100644 --- a/src/rapidata/api_client/models/i_example_payload_compare_example_payload.py +++ b/src/rapidata/api_client/models/i_example_payload_compare_example_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_payload_line_example_payload.py b/src/rapidata/api_client/models/i_example_payload_line_example_payload.py index 0145bd21cf..ef0543daf6 100644 --- a/src/rapidata/api_client/models/i_example_payload_line_example_payload.py +++ b/src/rapidata/api_client/models/i_example_payload_line_example_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_payload_locate_example_payload.py b/src/rapidata/api_client/models/i_example_payload_locate_example_payload.py index 610b8ba833..b3ce7da1dd 100644 --- a/src/rapidata/api_client/models/i_example_payload_locate_example_payload.py +++ b/src/rapidata/api_client/models/i_example_payload_locate_example_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_payload_scrub_example_payload.py b/src/rapidata/api_client/models/i_example_payload_scrub_example_payload.py index 6a360c1263..d1fa0d9941 100644 --- a/src/rapidata/api_client/models/i_example_payload_scrub_example_payload.py +++ b/src/rapidata/api_client/models/i_example_payload_scrub_example_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_payload_transcription_example_payload.py b/src/rapidata/api_client/models/i_example_payload_transcription_example_payload.py index 1748168d97..5207c1b981 100644 --- a/src/rapidata/api_client/models/i_example_payload_transcription_example_payload.py +++ b/src/rapidata/api_client/models/i_example_payload_transcription_example_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_truth.py b/src/rapidata/api_client/models/i_example_truth.py index 7634979732..95550cf0eb 100644 --- a/src/rapidata/api_client/models/i_example_truth.py +++ b/src/rapidata/api_client/models/i_example_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_truth_classify_example_truth.py b/src/rapidata/api_client/models/i_example_truth_classify_example_truth.py index 1cebb68b41..dd5f376dae 100644 --- a/src/rapidata/api_client/models/i_example_truth_classify_example_truth.py +++ b/src/rapidata/api_client/models/i_example_truth_classify_example_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_truth_compare_example_truth.py b/src/rapidata/api_client/models/i_example_truth_compare_example_truth.py index 3c94646f54..b76f7b1eda 100644 --- a/src/rapidata/api_client/models/i_example_truth_compare_example_truth.py +++ b/src/rapidata/api_client/models/i_example_truth_compare_example_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_truth_line_example_truth.py b/src/rapidata/api_client/models/i_example_truth_line_example_truth.py index 7059da25f3..89b461b20a 100644 --- a/src/rapidata/api_client/models/i_example_truth_line_example_truth.py +++ b/src/rapidata/api_client/models/i_example_truth_line_example_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_truth_locate_example_truth.py b/src/rapidata/api_client/models/i_example_truth_locate_example_truth.py index 244fff5ce5..ffb84b8076 100644 --- a/src/rapidata/api_client/models/i_example_truth_locate_example_truth.py +++ b/src/rapidata/api_client/models/i_example_truth_locate_example_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_truth_scrub_example_truth.py b/src/rapidata/api_client/models/i_example_truth_scrub_example_truth.py index 0c3ca9adb6..b3c1dd69be 100644 --- a/src/rapidata/api_client/models/i_example_truth_scrub_example_truth.py +++ b/src/rapidata/api_client/models/i_example_truth_scrub_example_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_example_truth_transcription_example_truth.py b/src/rapidata/api_client/models/i_example_truth_transcription_example_truth.py index d29bc2f711..6f1b103978 100644 --- a/src/rapidata/api_client/models/i_example_truth_transcription_example_truth.py +++ b/src/rapidata/api_client/models/i_example_truth_transcription_example_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_faucet_input.py b/src/rapidata/api_client/models/i_faucet_input.py index 5b8a7e20ce..6d79284679 100644 --- a/src/rapidata/api_client/models/i_faucet_input.py +++ b/src/rapidata/api_client/models/i_faucet_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_faucet_input_replicate_faucet_input.py b/src/rapidata/api_client/models/i_faucet_input_replicate_faucet_input.py index 036dc2270f..c98eeeef02 100644 --- a/src/rapidata/api_client/models/i_faucet_input_replicate_faucet_input.py +++ b/src/rapidata/api_client/models/i_faucet_input_replicate_faucet_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_faucet_output.py b/src/rapidata/api_client/models/i_faucet_output.py index 97dcc9aa73..482be0269d 100644 --- a/src/rapidata/api_client/models/i_faucet_output.py +++ b/src/rapidata/api_client/models/i_faucet_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_faucet_output_managed_faucet_output.py b/src/rapidata/api_client/models/i_faucet_output_managed_faucet_output.py index 33d8b277b5..a2c3aa28c9 100644 --- a/src/rapidata/api_client/models/i_faucet_output_managed_faucet_output.py +++ b/src/rapidata/api_client/models/i_faucet_output_managed_faucet_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_faucet_output_replicate_faucet_output.py b/src/rapidata/api_client/models/i_faucet_output_replicate_faucet_output.py index 0001839fdb..a3624304a6 100644 --- a/src/rapidata/api_client/models/i_faucet_output_replicate_faucet_output.py +++ b/src/rapidata/api_client/models/i_faucet_output_replicate_faucet_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_flow.py b/src/rapidata/api_client/models/i_flow.py index e68ebee582..f230c9a1f4 100644 --- a/src/rapidata/api_client/models/i_flow.py +++ b/src/rapidata/api_client/models/i_flow.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_flow_ranking_flow.py b/src/rapidata/api_client/models/i_flow_ranking_flow.py index 300a5913f1..49d367f59b 100644 --- a/src/rapidata/api_client/models/i_flow_ranking_flow.py +++ b/src/rapidata/api_client/models/i_flow_ranking_flow.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_graduation_rule.py b/src/rapidata/api_client/models/i_graduation_rule.py index 1659650392..517b546cb0 100644 --- a/src/rapidata/api_client/models/i_graduation_rule.py +++ b/src/rapidata/api_client/models/i_graduation_rule.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_graduation_rule_accepted_free_text_rule.py b/src/rapidata/api_client/models/i_graduation_rule_accepted_free_text_rule.py index 3c78cd3a23..4b4fd4cc8a 100644 --- a/src/rapidata/api_client/models/i_graduation_rule_accepted_free_text_rule.py +++ b/src/rapidata/api_client/models/i_graduation_rule_accepted_free_text_rule.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_graduation_rule_score_threshold_rule.py b/src/rapidata/api_client/models/i_graduation_rule_score_threshold_rule.py index bd5c6380a1..5196f59ac1 100644 --- a/src/rapidata/api_client/models/i_graduation_rule_score_threshold_rule.py +++ b/src/rapidata/api_client/models/i_graduation_rule_score_threshold_rule.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_graduation_rule_task_accuracy_rule.py b/src/rapidata/api_client/models/i_graduation_rule_task_accuracy_rule.py index 58380284d9..b746bded06 100644 --- a/src/rapidata/api_client/models/i_graduation_rule_task_accuracy_rule.py +++ b/src/rapidata/api_client/models/i_graduation_rule_task_accuracy_rule.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_job_results.py b/src/rapidata/api_client/models/i_job_results.py index ba35dc0dd1..3e1adf210e 100644 --- a/src/rapidata/api_client/models/i_job_results.py +++ b/src/rapidata/api_client/models/i_job_results.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_job_results_grouped_ranking_results.py b/src/rapidata/api_client/models/i_job_results_grouped_ranking_results.py index 7c30e4c24c..9f99226383 100644 --- a/src/rapidata/api_client/models/i_job_results_grouped_ranking_results.py +++ b/src/rapidata/api_client/models/i_job_results_grouped_ranking_results.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_job_results_ranking_results.py b/src/rapidata/api_client/models/i_job_results_ranking_results.py index 3bd86fdd8f..0bedfb1f58 100644 --- a/src/rapidata/api_client/models/i_job_results_ranking_results.py +++ b/src/rapidata/api_client/models/i_job_results_ranking_results.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_job_results_rapid_results.py b/src/rapidata/api_client/models/i_job_results_rapid_results.py index 2d3f75fd2d..ab708109ce 100644 --- a/src/rapidata/api_client/models/i_job_results_rapid_results.py +++ b/src/rapidata/api_client/models/i_job_results_rapid_results.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_line_item.py b/src/rapidata/api_client/models/i_line_item.py index 671d8139a9..2dbb696aab 100644 --- a/src/rapidata/api_client/models/i_line_item.py +++ b/src/rapidata/api_client/models/i_line_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_line_item_minimum_spend_commitment.py b/src/rapidata/api_client/models/i_line_item_minimum_spend_commitment.py index 88d5df7199..071c2925bd 100644 --- a/src/rapidata/api_client/models/i_line_item_minimum_spend_commitment.py +++ b/src/rapidata/api_client/models/i_line_item_minimum_spend_commitment.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_line_item_other_charge.py b/src/rapidata/api_client/models/i_line_item_other_charge.py index 2d148c1d10..6395a4236d 100644 --- a/src/rapidata/api_client/models/i_line_item_other_charge.py +++ b/src/rapidata/api_client/models/i_line_item_other_charge.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_line_item_platform_fee.py b/src/rapidata/api_client/models/i_line_item_platform_fee.py index 167be6c576..b611a521c4 100644 --- a/src/rapidata/api_client/models/i_line_item_platform_fee.py +++ b/src/rapidata/api_client/models/i_line_item_platform_fee.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_line_item_refund.py b/src/rapidata/api_client/models/i_line_item_refund.py index b0b01aa838..aeb2d414fb 100644 --- a/src/rapidata/api_client/models/i_line_item_refund.py +++ b/src/rapidata/api_client/models/i_line_item_refund.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_line_item_running_cost.py b/src/rapidata/api_client/models/i_line_item_running_cost.py index c760d8e180..9f349ae944 100644 --- a/src/rapidata/api_client/models/i_line_item_running_cost.py +++ b/src/rapidata/api_client/models/i_line_item_running_cost.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_line_item_volume_discount.py b/src/rapidata/api_client/models/i_line_item_volume_discount.py index b5a9ceaa9c..a08a9b6730 100644 --- a/src/rapidata/api_client/models/i_line_item_volume_discount.py +++ b/src/rapidata/api_client/models/i_line_item_volume_discount.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata.py b/src/rapidata/api_client/models/i_metadata.py index feb190d7b0..ba44a96916 100644 --- a/src/rapidata/api_client/models/i_metadata.py +++ b/src/rapidata/api_client/models/i_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_classification_metadata.py b/src/rapidata/api_client/models/i_metadata_classification_metadata.py index 1d39d2c3e0..071a4e1aff 100644 --- a/src/rapidata/api_client/models/i_metadata_classification_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_classification_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_count_metadata.py b/src/rapidata/api_client/models/i_metadata_count_metadata.py index fd3618adc1..9c3233b3e6 100644 --- a/src/rapidata/api_client/models/i_metadata_count_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_count_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_file_type_metadata.py b/src/rapidata/api_client/models/i_metadata_file_type_metadata.py index 58c69bb32f..dc4627a45d 100644 --- a/src/rapidata/api_client/models/i_metadata_file_type_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_file_type_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_image_dimension_metadata.py b/src/rapidata/api_client/models/i_metadata_image_dimension_metadata.py index eabd5f5daa..c4b4e2cbf7 100644 --- a/src/rapidata/api_client/models/i_metadata_image_dimension_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_image_dimension_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_input_text_metadata_input.py b/src/rapidata/api_client/models/i_metadata_input_text_metadata_input.py index 8a4b3afebb..ae8b292dba 100644 --- a/src/rapidata/api_client/models/i_metadata_input_text_metadata_input.py +++ b/src/rapidata/api_client/models/i_metadata_input_text_metadata_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_location_metadata.py b/src/rapidata/api_client/models/i_metadata_location_metadata.py index 8f9badf90a..55e6380439 100644 --- a/src/rapidata/api_client/models/i_metadata_location_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_location_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_original_filename_metadata.py b/src/rapidata/api_client/models/i_metadata_original_filename_metadata.py index 4939ba6369..da08fee0c4 100644 --- a/src/rapidata/api_client/models/i_metadata_original_filename_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_original_filename_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_source_url_metadata.py b/src/rapidata/api_client/models/i_metadata_source_url_metadata.py index 2547027717..1327ab568f 100644 --- a/src/rapidata/api_client/models/i_metadata_source_url_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_source_url_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_streams_metadata.py b/src/rapidata/api_client/models/i_metadata_streams_metadata.py index ad220d9b00..8c18a22843 100644 --- a/src/rapidata/api_client/models/i_metadata_streams_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_streams_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_text_metadata.py b/src/rapidata/api_client/models/i_metadata_text_metadata.py index 08114c5c3b..95230b5bc2 100644 --- a/src/rapidata/api_client/models/i_metadata_text_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_text_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_metadata_video_duration_metadata.py b/src/rapidata/api_client/models/i_metadata_video_duration_metadata.py index 1c34c54174..b7c243f801 100644 --- a/src/rapidata/api_client/models/i_metadata_video_duration_metadata.py +++ b/src/rapidata/api_client/models/i_metadata_video_duration_metadata.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_order_workflow_input.py b/src/rapidata/api_client/models/i_order_workflow_input.py index 608088018b..a5987a9bfe 100644 --- a/src/rapidata/api_client/models/i_order_workflow_input.py +++ b/src/rapidata/api_client/models/i_order_workflow_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_order_workflow_input_evaluation_workflow_input.py b/src/rapidata/api_client/models/i_order_workflow_input_evaluation_workflow_input.py index f5626e7ce9..b49f2d519d 100644 --- a/src/rapidata/api_client/models/i_order_workflow_input_evaluation_workflow_input.py +++ b/src/rapidata/api_client/models/i_order_workflow_input_evaluation_workflow_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_order_workflow_input_grouped_ranking_workflow_input.py b/src/rapidata/api_client/models/i_order_workflow_input_grouped_ranking_workflow_input.py index 39414c303c..34b3ba3c90 100644 --- a/src/rapidata/api_client/models/i_order_workflow_input_grouped_ranking_workflow_input.py +++ b/src/rapidata/api_client/models/i_order_workflow_input_grouped_ranking_workflow_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_order_workflow_input_simple_workflow_input.py b/src/rapidata/api_client/models/i_order_workflow_input_simple_workflow_input.py index d5ae7a815e..a475d4e35f 100644 --- a/src/rapidata/api_client/models/i_order_workflow_input_simple_workflow_input.py +++ b/src/rapidata/api_client/models/i_order_workflow_input_simple_workflow_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pair_maker_config.py b/src/rapidata/api_client/models/i_pair_maker_config.py index b34e5110a2..5f51a15ab2 100644 --- a/src/rapidata/api_client/models/i_pair_maker_config.py +++ b/src/rapidata/api_client/models/i_pair_maker_config.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pair_maker_config_full_permutation_pair_maker_config.py b/src/rapidata/api_client/models/i_pair_maker_config_full_permutation_pair_maker_config.py index 511f943d86..b17688c38a 100644 --- a/src/rapidata/api_client/models/i_pair_maker_config_full_permutation_pair_maker_config.py +++ b/src/rapidata/api_client/models/i_pair_maker_config_full_permutation_pair_maker_config.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pair_maker_config_online_pair_maker_config.py b/src/rapidata/api_client/models/i_pair_maker_config_online_pair_maker_config.py index 4a16e63a86..e993ab8c51 100644 --- a/src/rapidata/api_client/models/i_pair_maker_config_online_pair_maker_config.py +++ b/src/rapidata/api_client/models/i_pair_maker_config_online_pair_maker_config.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pair_maker_information.py b/src/rapidata/api_client/models/i_pair_maker_information.py index 89b7a60bd6..70dc7ae43c 100644 --- a/src/rapidata/api_client/models/i_pair_maker_information.py +++ b/src/rapidata/api_client/models/i_pair_maker_information.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pair_maker_information_full_permutation_pair_maker_information.py b/src/rapidata/api_client/models/i_pair_maker_information_full_permutation_pair_maker_information.py index 61f0cab378..4aaae715fb 100644 --- a/src/rapidata/api_client/models/i_pair_maker_information_full_permutation_pair_maker_information.py +++ b/src/rapidata/api_client/models/i_pair_maker_information_full_permutation_pair_maker_information.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pair_maker_information_online_pair_maker_information.py b/src/rapidata/api_client/models/i_pair_maker_information_online_pair_maker_information.py index 834bcd062d..adb4351622 100644 --- a/src/rapidata/api_client/models/i_pair_maker_information_online_pair_maker_information.py +++ b/src/rapidata/api_client/models/i_pair_maker_information_online_pair_maker_information.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pipeline_artifact_create_dataset_artifact.py b/src/rapidata/api_client/models/i_pipeline_artifact_create_dataset_artifact.py index 96c9065540..efc0e924aa 100644 --- a/src/rapidata/api_client/models/i_pipeline_artifact_create_dataset_artifact.py +++ b/src/rapidata/api_client/models/i_pipeline_artifact_create_dataset_artifact.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pipeline_asset.py b/src/rapidata/api_client/models/i_pipeline_asset.py deleted file mode 100644 index dab3d495ed..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_asset.py +++ /dev/null @@ -1,167 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -from __future__ import annotations -import json -import pprint -from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator -from typing import Any, List, Optional -from rapidata.api_client.models.i_pipeline_asset_pipeline_file_asset import IPipelineAssetPipelineFileAsset -from rapidata.api_client.models.i_pipeline_asset_pipeline_null_asset import IPipelineAssetPipelineNullAsset -from rapidata.api_client.models.i_pipeline_asset_pipeline_text_asset import IPipelineAssetPipelineTextAsset -from pydantic import StrictStr, Field -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Union, List, Set, Optional, Dict -from typing_extensions import Literal, Self - -IPIPELINEASSET_ONE_OF_SCHEMAS = ["IPipelineAssetPipelineFileAsset", "IPipelineAssetPipelineMultiAsset", "IPipelineAssetPipelineNullAsset", "IPipelineAssetPipelineTextAsset"] - -class IPipelineAsset(LazyValidatedModel): - """ - IPipelineAsset - """ - # data type: IPipelineAssetPipelineFileAsset - oneof_schema_1_validator: Optional[IPipelineAssetPipelineFileAsset] = None - # data type: IPipelineAssetPipelineMultiAsset - oneof_schema_2_validator: Optional[IPipelineAssetPipelineMultiAsset] = None - # data type: IPipelineAssetPipelineNullAsset - oneof_schema_3_validator: Optional[IPipelineAssetPipelineNullAsset] = None - # data type: IPipelineAssetPipelineTextAsset - oneof_schema_4_validator: Optional[IPipelineAssetPipelineTextAsset] = None - actual_instance: Optional[Union[IPipelineAssetPipelineFileAsset, IPipelineAssetPipelineMultiAsset, IPipelineAssetPipelineNullAsset, IPipelineAssetPipelineTextAsset]] = None - one_of_schemas: Set[str] = { "IPipelineAssetPipelineFileAsset", "IPipelineAssetPipelineMultiAsset", "IPipelineAssetPipelineNullAsset", "IPipelineAssetPipelineTextAsset" } - - # model_config is inherited from LazyValidatedModel - - - discriminator_value_class_map: Dict[str, str] = { - } - - def __init__(self, *args, **kwargs) -> None: - if args: - if len(args) > 1: - raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") - if kwargs: - raise ValueError("If a position argument is used, keyword arguments cannot be used.") - super().__init__(actual_instance=args[0]) - else: - super().__init__(**kwargs) - - @field_validator('actual_instance') - def actual_instance_must_validate_oneof(cls, v): - instance = IPipelineAsset.model_construct() - error_messages = [] - match = 0 - # validate data type: IPipelineAssetPipelineFileAsset - if not isinstance(v, IPipelineAssetPipelineFileAsset): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineAssetPipelineFileAsset`") - else: - match += 1 - # validate data type: IPipelineAssetPipelineMultiAsset - if not isinstance(v, IPipelineAssetPipelineMultiAsset): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineAssetPipelineMultiAsset`") - else: - match += 1 - # validate data type: IPipelineAssetPipelineNullAsset - if not isinstance(v, IPipelineAssetPipelineNullAsset): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineAssetPipelineNullAsset`") - else: - match += 1 - # validate data type: IPipelineAssetPipelineTextAsset - if not isinstance(v, IPipelineAssetPipelineTextAsset): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineAssetPipelineTextAsset`") - else: - match += 1 - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in IPipelineAsset with oneOf schemas: IPipelineAssetPipelineFileAsset, IPipelineAssetPipelineMultiAsset, IPipelineAssetPipelineNullAsset, IPipelineAssetPipelineTextAsset. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when setting `actual_instance` in IPipelineAsset with oneOf schemas: IPipelineAssetPipelineFileAsset, IPipelineAssetPipelineMultiAsset, IPipelineAssetPipelineNullAsset, IPipelineAssetPipelineTextAsset. Details: " + ", ".join(error_messages)) - else: - return v - - @classmethod - def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: - return cls.from_json(json.dumps(obj)) - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Returns the object represented by the json string""" - instance = cls.model_construct() - error_messages = [] - match = 0 - - # deserialize data into IPipelineAssetPipelineFileAsset - try: - instance.actual_instance = IPipelineAssetPipelineFileAsset.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineAssetPipelineMultiAsset - try: - instance.actual_instance = IPipelineAssetPipelineMultiAsset.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineAssetPipelineNullAsset - try: - instance.actual_instance = IPipelineAssetPipelineNullAsset.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineAssetPipelineTextAsset - try: - instance.actual_instance = IPipelineAssetPipelineTextAsset.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into IPipelineAsset with oneOf schemas: IPipelineAssetPipelineFileAsset, IPipelineAssetPipelineMultiAsset, IPipelineAssetPipelineNullAsset, IPipelineAssetPipelineTextAsset. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when deserializing the JSON string into IPipelineAsset with oneOf schemas: IPipelineAssetPipelineFileAsset, IPipelineAssetPipelineMultiAsset, IPipelineAssetPipelineNullAsset, IPipelineAssetPipelineTextAsset. Details: " + ", ".join(error_messages)) - else: - return instance - - def to_json(self) -> str: - """Returns the JSON representation of the actual instance""" - if self.actual_instance is None: - return "null" - - if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): - return self.actual_instance.to_json() - else: - return json.dumps(self.actual_instance) - - def to_dict(self) -> Optional[Union[Dict[str, Any], IPipelineAssetPipelineFileAsset, IPipelineAssetPipelineMultiAsset, IPipelineAssetPipelineNullAsset, IPipelineAssetPipelineTextAsset]]: - """Returns the dict representation of the actual instance""" - if self.actual_instance is None: - return None - - if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): - return self.actual_instance.to_dict() - else: - # primitive type - return self.actual_instance - - def to_str(self) -> str: - """Returns the string representation of the actual instance""" - return pprint.pformat(self.model_dump()) - -from rapidata.api_client.models.i_pipeline_asset_pipeline_multi_asset import IPipelineAssetPipelineMultiAsset -# TODO: Rewrite to not use raise_errors -IPipelineAsset.model_rebuild(raise_errors=False) - diff --git a/src/rapidata/api_client/models/i_pipeline_asset_pipeline_file_asset.py b/src/rapidata/api_client/models/i_pipeline_asset_pipeline_file_asset.py deleted file mode 100644 index a0e7186d97..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_asset_pipeline_file_asset.py +++ /dev/null @@ -1,112 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from rapidata.api_client.models.i_pipeline_metadata import IPipelineMetadata -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineAssetPipelineFileAsset(LazyValidatedModel): - """ - IPipelineAssetPipelineFileAsset - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - file_name: StrictStr = Field(alias="fileName") - metadata: Dict[str, IPipelineMetadata] - __properties: ClassVar[List[str]] = ["_t", "fileName", "metadata"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['FileAsset']): - raise ValueError("must be one of enum values ('FileAsset')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineAssetPipelineFileAsset 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 value in metadata (dict) - _field_dict = {} - if self.metadata: - for _key_metadata in self.metadata: - if self.metadata[_key_metadata]: - _field_dict[_key_metadata] = self.metadata[_key_metadata].to_dict() - _dict['metadata'] = _field_dict - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IPipelineAssetPipelineFileAsset from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "fileName": obj.get("fileName"), - "metadata": dict( - (_k, IPipelineMetadata.from_dict(_v)) - for _k, _v in obj["metadata"].items() - ) - if obj.get("metadata") is not None - else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_asset_pipeline_multi_asset.py b/src/rapidata/api_client/models/i_pipeline_asset_pipeline_multi_asset.py deleted file mode 100644 index 94c891cc08..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_asset_pipeline_multi_asset.py +++ /dev/null @@ -1,122 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from rapidata.api_client.models.i_pipeline_metadata import IPipelineMetadata -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineAssetPipelineMultiAsset(LazyValidatedModel): - """ - IPipelineAssetPipelineMultiAsset - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - assets: List[IPipelineAsset] - metadata: Dict[str, IPipelineMetadata] - __properties: ClassVar[List[str]] = ["_t", "assets", "metadata"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['MultiAsset']): - raise ValueError("must be one of enum values ('MultiAsset')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineAssetPipelineMultiAsset 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 assets (list) - _items = [] - if self.assets: - for _item_assets in self.assets: - if _item_assets: - _items.append(_item_assets.to_dict()) - _dict['assets'] = _items - # override the default output from pydantic by calling `to_dict()` of each value in metadata (dict) - _field_dict = {} - if self.metadata: - for _key_metadata in self.metadata: - if self.metadata[_key_metadata]: - _field_dict[_key_metadata] = self.metadata[_key_metadata].to_dict() - _dict['metadata'] = _field_dict - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IPipelineAssetPipelineMultiAsset from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "assets": [IPipelineAsset.from_dict(_item) for _item in obj["assets"]] if obj.get("assets") is not None else None, - "metadata": dict( - (_k, IPipelineMetadata.from_dict(_v)) - for _k, _v in obj["metadata"].items() - ) - if obj.get("metadata") is not None - else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - -from rapidata.api_client.models.i_pipeline_asset import IPipelineAsset -# TODO: Rewrite to not use raise_errors -IPipelineAssetPipelineMultiAsset.model_rebuild(raise_errors=False) - diff --git a/src/rapidata/api_client/models/i_pipeline_asset_pipeline_null_asset.py b/src/rapidata/api_client/models/i_pipeline_asset_pipeline_null_asset.py deleted file mode 100644 index a8c187b40e..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_asset_pipeline_null_asset.py +++ /dev/null @@ -1,110 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from rapidata.api_client.models.i_pipeline_metadata import IPipelineMetadata -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineAssetPipelineNullAsset(LazyValidatedModel): - """ - IPipelineAssetPipelineNullAsset - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - metadata: Dict[str, IPipelineMetadata] - __properties: ClassVar[List[str]] = ["_t", "metadata"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['NullAsset']): - raise ValueError("must be one of enum values ('NullAsset')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineAssetPipelineNullAsset 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 value in metadata (dict) - _field_dict = {} - if self.metadata: - for _key_metadata in self.metadata: - if self.metadata[_key_metadata]: - _field_dict[_key_metadata] = self.metadata[_key_metadata].to_dict() - _dict['metadata'] = _field_dict - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IPipelineAssetPipelineNullAsset from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "metadata": dict( - (_k, IPipelineMetadata.from_dict(_v)) - for _k, _v in obj["metadata"].items() - ) - if obj.get("metadata") is not None - else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_asset_pipeline_text_asset.py b/src/rapidata/api_client/models/i_pipeline_asset_pipeline_text_asset.py deleted file mode 100644 index 59e72c038a..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_asset_pipeline_text_asset.py +++ /dev/null @@ -1,112 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from rapidata.api_client.models.i_pipeline_metadata import IPipelineMetadata -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineAssetPipelineTextAsset(LazyValidatedModel): - """ - IPipelineAssetPipelineTextAsset - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - text: StrictStr - metadata: Dict[str, IPipelineMetadata] - __properties: ClassVar[List[str]] = ["_t", "text", "metadata"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['TextAsset']): - raise ValueError("must be one of enum values ('TextAsset')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineAssetPipelineTextAsset 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 value in metadata (dict) - _field_dict = {} - if self.metadata: - for _key_metadata in self.metadata: - if self.metadata[_key_metadata]: - _field_dict[_key_metadata] = self.metadata[_key_metadata].to_dict() - _dict['metadata'] = _field_dict - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IPipelineAssetPipelineTextAsset from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "text": obj.get("text"), - "metadata": dict( - (_k, IPipelineMetadata.from_dict(_v)) - for _k, _v in obj["metadata"].items() - ) - if obj.get("metadata") is not None - else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_create_simple_pipeline.py b/src/rapidata/api_client/models/i_pipeline_create_simple_pipeline.py index 1711777e8f..3bfea80bb9 100644 --- a/src/rapidata/api_client/models/i_pipeline_create_simple_pipeline.py +++ b/src/rapidata/api_client/models/i_pipeline_create_simple_pipeline.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pipeline_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata.py deleted file mode 100644 index 880132688b..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata.py +++ /dev/null @@ -1,249 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -from __future__ import annotations -import json -import pprint -from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator -from typing import Any, List, Optional -from rapidata.api_client.models.i_pipeline_metadata_pipeline_classification_metadata import IPipelineMetadataPipelineClassificationMetadata -from rapidata.api_client.models.i_pipeline_metadata_pipeline_count_metadata import IPipelineMetadataPipelineCountMetadata -from rapidata.api_client.models.i_pipeline_metadata_pipeline_duration_metadata import IPipelineMetadataPipelineDurationMetadata -from rapidata.api_client.models.i_pipeline_metadata_pipeline_file_type_metadata import IPipelineMetadataPipelineFileTypeMetadata -from rapidata.api_client.models.i_pipeline_metadata_pipeline_image_dimension_metadata import IPipelineMetadataPipelineImageDimensionMetadata -from rapidata.api_client.models.i_pipeline_metadata_pipeline_location_metadata import IPipelineMetadataPipelineLocationMetadata -from rapidata.api_client.models.i_pipeline_metadata_pipeline_original_filename_metadata import IPipelineMetadataPipelineOriginalFilenameMetadata -from rapidata.api_client.models.i_pipeline_metadata_pipeline_source_url_metadata import IPipelineMetadataPipelineSourceUrlMetadata -from rapidata.api_client.models.i_pipeline_metadata_pipeline_streams_metadata import IPipelineMetadataPipelineStreamsMetadata -from rapidata.api_client.models.i_pipeline_metadata_pipeline_text_metadata import IPipelineMetadataPipelineTextMetadata -from pydantic import StrictStr, Field -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Union, List, Set, Optional, Dict -from typing_extensions import Literal, Self - -IPIPELINEMETADATA_ONE_OF_SCHEMAS = ["IPipelineMetadataPipelineClassificationMetadata", "IPipelineMetadataPipelineCountMetadata", "IPipelineMetadataPipelineDurationMetadata", "IPipelineMetadataPipelineFileTypeMetadata", "IPipelineMetadataPipelineImageDimensionMetadata", "IPipelineMetadataPipelineLocationMetadata", "IPipelineMetadataPipelineOriginalFilenameMetadata", "IPipelineMetadataPipelineSourceUrlMetadata", "IPipelineMetadataPipelineStreamsMetadata", "IPipelineMetadataPipelineTextMetadata"] - -class IPipelineMetadata(LazyValidatedModel): - """ - IPipelineMetadata - """ - # data type: IPipelineMetadataPipelineClassificationMetadata - oneof_schema_1_validator: Optional[IPipelineMetadataPipelineClassificationMetadata] = None - # data type: IPipelineMetadataPipelineCountMetadata - oneof_schema_2_validator: Optional[IPipelineMetadataPipelineCountMetadata] = None - # data type: IPipelineMetadataPipelineDurationMetadata - oneof_schema_3_validator: Optional[IPipelineMetadataPipelineDurationMetadata] = None - # data type: IPipelineMetadataPipelineFileTypeMetadata - oneof_schema_4_validator: Optional[IPipelineMetadataPipelineFileTypeMetadata] = None - # data type: IPipelineMetadataPipelineImageDimensionMetadata - oneof_schema_5_validator: Optional[IPipelineMetadataPipelineImageDimensionMetadata] = None - # data type: IPipelineMetadataPipelineLocationMetadata - oneof_schema_6_validator: Optional[IPipelineMetadataPipelineLocationMetadata] = None - # data type: IPipelineMetadataPipelineOriginalFilenameMetadata - oneof_schema_7_validator: Optional[IPipelineMetadataPipelineOriginalFilenameMetadata] = None - # data type: IPipelineMetadataPipelineSourceUrlMetadata - oneof_schema_8_validator: Optional[IPipelineMetadataPipelineSourceUrlMetadata] = None - # data type: IPipelineMetadataPipelineStreamsMetadata - oneof_schema_9_validator: Optional[IPipelineMetadataPipelineStreamsMetadata] = None - # data type: IPipelineMetadataPipelineTextMetadata - oneof_schema_10_validator: Optional[IPipelineMetadataPipelineTextMetadata] = None - actual_instance: Optional[Union[IPipelineMetadataPipelineClassificationMetadata, IPipelineMetadataPipelineCountMetadata, IPipelineMetadataPipelineDurationMetadata, IPipelineMetadataPipelineFileTypeMetadata, IPipelineMetadataPipelineImageDimensionMetadata, IPipelineMetadataPipelineLocationMetadata, IPipelineMetadataPipelineOriginalFilenameMetadata, IPipelineMetadataPipelineSourceUrlMetadata, IPipelineMetadataPipelineStreamsMetadata, IPipelineMetadataPipelineTextMetadata]] = None - one_of_schemas: Set[str] = { "IPipelineMetadataPipelineClassificationMetadata", "IPipelineMetadataPipelineCountMetadata", "IPipelineMetadataPipelineDurationMetadata", "IPipelineMetadataPipelineFileTypeMetadata", "IPipelineMetadataPipelineImageDimensionMetadata", "IPipelineMetadataPipelineLocationMetadata", "IPipelineMetadataPipelineOriginalFilenameMetadata", "IPipelineMetadataPipelineSourceUrlMetadata", "IPipelineMetadataPipelineStreamsMetadata", "IPipelineMetadataPipelineTextMetadata" } - - # model_config is inherited from LazyValidatedModel - - - discriminator_value_class_map: Dict[str, str] = { - } - - def __init__(self, *args, **kwargs) -> None: - if args: - if len(args) > 1: - raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") - if kwargs: - raise ValueError("If a position argument is used, keyword arguments cannot be used.") - super().__init__(actual_instance=args[0]) - else: - super().__init__(**kwargs) - - @field_validator('actual_instance') - def actual_instance_must_validate_oneof(cls, v): - instance = IPipelineMetadata.model_construct() - error_messages = [] - match = 0 - # validate data type: IPipelineMetadataPipelineClassificationMetadata - if not isinstance(v, IPipelineMetadataPipelineClassificationMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineClassificationMetadata`") - else: - match += 1 - # validate data type: IPipelineMetadataPipelineCountMetadata - if not isinstance(v, IPipelineMetadataPipelineCountMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineCountMetadata`") - else: - match += 1 - # validate data type: IPipelineMetadataPipelineDurationMetadata - if not isinstance(v, IPipelineMetadataPipelineDurationMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineDurationMetadata`") - else: - match += 1 - # validate data type: IPipelineMetadataPipelineFileTypeMetadata - if not isinstance(v, IPipelineMetadataPipelineFileTypeMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineFileTypeMetadata`") - else: - match += 1 - # validate data type: IPipelineMetadataPipelineImageDimensionMetadata - if not isinstance(v, IPipelineMetadataPipelineImageDimensionMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineImageDimensionMetadata`") - else: - match += 1 - # validate data type: IPipelineMetadataPipelineLocationMetadata - if not isinstance(v, IPipelineMetadataPipelineLocationMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineLocationMetadata`") - else: - match += 1 - # validate data type: IPipelineMetadataPipelineOriginalFilenameMetadata - if not isinstance(v, IPipelineMetadataPipelineOriginalFilenameMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineOriginalFilenameMetadata`") - else: - match += 1 - # validate data type: IPipelineMetadataPipelineSourceUrlMetadata - if not isinstance(v, IPipelineMetadataPipelineSourceUrlMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineSourceUrlMetadata`") - else: - match += 1 - # validate data type: IPipelineMetadataPipelineStreamsMetadata - if not isinstance(v, IPipelineMetadataPipelineStreamsMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineStreamsMetadata`") - else: - match += 1 - # validate data type: IPipelineMetadataPipelineTextMetadata - if not isinstance(v, IPipelineMetadataPipelineTextMetadata): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineMetadataPipelineTextMetadata`") - else: - match += 1 - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in IPipelineMetadata with oneOf schemas: IPipelineMetadataPipelineClassificationMetadata, IPipelineMetadataPipelineCountMetadata, IPipelineMetadataPipelineDurationMetadata, IPipelineMetadataPipelineFileTypeMetadata, IPipelineMetadataPipelineImageDimensionMetadata, IPipelineMetadataPipelineLocationMetadata, IPipelineMetadataPipelineOriginalFilenameMetadata, IPipelineMetadataPipelineSourceUrlMetadata, IPipelineMetadataPipelineStreamsMetadata, IPipelineMetadataPipelineTextMetadata. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when setting `actual_instance` in IPipelineMetadata with oneOf schemas: IPipelineMetadataPipelineClassificationMetadata, IPipelineMetadataPipelineCountMetadata, IPipelineMetadataPipelineDurationMetadata, IPipelineMetadataPipelineFileTypeMetadata, IPipelineMetadataPipelineImageDimensionMetadata, IPipelineMetadataPipelineLocationMetadata, IPipelineMetadataPipelineOriginalFilenameMetadata, IPipelineMetadataPipelineSourceUrlMetadata, IPipelineMetadataPipelineStreamsMetadata, IPipelineMetadataPipelineTextMetadata. Details: " + ", ".join(error_messages)) - else: - return v - - @classmethod - def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: - return cls.from_json(json.dumps(obj)) - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Returns the object represented by the json string""" - instance = cls.model_construct() - error_messages = [] - match = 0 - - # deserialize data into IPipelineMetadataPipelineClassificationMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineClassificationMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineMetadataPipelineCountMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineCountMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineMetadataPipelineDurationMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineDurationMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineMetadataPipelineFileTypeMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineFileTypeMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineMetadataPipelineImageDimensionMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineImageDimensionMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineMetadataPipelineLocationMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineLocationMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineMetadataPipelineOriginalFilenameMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineOriginalFilenameMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineMetadataPipelineSourceUrlMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineSourceUrlMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineMetadataPipelineStreamsMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineStreamsMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineMetadataPipelineTextMetadata - try: - instance.actual_instance = IPipelineMetadataPipelineTextMetadata.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into IPipelineMetadata with oneOf schemas: IPipelineMetadataPipelineClassificationMetadata, IPipelineMetadataPipelineCountMetadata, IPipelineMetadataPipelineDurationMetadata, IPipelineMetadataPipelineFileTypeMetadata, IPipelineMetadataPipelineImageDimensionMetadata, IPipelineMetadataPipelineLocationMetadata, IPipelineMetadataPipelineOriginalFilenameMetadata, IPipelineMetadataPipelineSourceUrlMetadata, IPipelineMetadataPipelineStreamsMetadata, IPipelineMetadataPipelineTextMetadata. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when deserializing the JSON string into IPipelineMetadata with oneOf schemas: IPipelineMetadataPipelineClassificationMetadata, IPipelineMetadataPipelineCountMetadata, IPipelineMetadataPipelineDurationMetadata, IPipelineMetadataPipelineFileTypeMetadata, IPipelineMetadataPipelineImageDimensionMetadata, IPipelineMetadataPipelineLocationMetadata, IPipelineMetadataPipelineOriginalFilenameMetadata, IPipelineMetadataPipelineSourceUrlMetadata, IPipelineMetadataPipelineStreamsMetadata, IPipelineMetadataPipelineTextMetadata. Details: " + ", ".join(error_messages)) - else: - return instance - - def to_json(self) -> str: - """Returns the JSON representation of the actual instance""" - if self.actual_instance is None: - return "null" - - if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): - return self.actual_instance.to_json() - else: - return json.dumps(self.actual_instance) - - def to_dict(self) -> Optional[Union[Dict[str, Any], IPipelineMetadataPipelineClassificationMetadata, IPipelineMetadataPipelineCountMetadata, IPipelineMetadataPipelineDurationMetadata, IPipelineMetadataPipelineFileTypeMetadata, IPipelineMetadataPipelineImageDimensionMetadata, IPipelineMetadataPipelineLocationMetadata, IPipelineMetadataPipelineOriginalFilenameMetadata, IPipelineMetadataPipelineSourceUrlMetadata, IPipelineMetadataPipelineStreamsMetadata, IPipelineMetadataPipelineTextMetadata]]: - """Returns the dict representation of the actual instance""" - if self.actual_instance is None: - return None - - if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): - return self.actual_instance.to_dict() - else: - # primitive type - return self.actual_instance - - def to_str(self) -> str: - """Returns the string representation of the actual instance""" - return pprint.pformat(self.model_dump()) - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_classification_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_classification_metadata.py deleted file mode 100644 index a39994d27f..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_classification_metadata.py +++ /dev/null @@ -1,107 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineClassificationMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineClassificationMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - classification: StrictStr - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "classification", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['ClassificationMetadata']): - raise ValueError("must be one of enum values ('ClassificationMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineClassificationMetadata 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 IPipelineMetadataPipelineClassificationMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "classification": obj.get("classification"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_count_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_count_metadata.py deleted file mode 100644 index 3d27be2411..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_count_metadata.py +++ /dev/null @@ -1,107 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List, Optional -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineCountMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineCountMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - count: Optional[StrictInt] = None - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "count", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['CountMetadata']): - raise ValueError("must be one of enum values ('CountMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineCountMetadata 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 IPipelineMetadataPipelineCountMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "count": obj.get("count"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_duration_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_duration_metadata.py deleted file mode 100644 index c7bc1245d3..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_duration_metadata.py +++ /dev/null @@ -1,108 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineDurationMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineDurationMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - duration: datetime - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "duration", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['DurationMetadata']): - raise ValueError("must be one of enum values ('DurationMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineDurationMetadata 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 IPipelineMetadataPipelineDurationMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "duration": obj.get("duration"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_file_type_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_file_type_metadata.py deleted file mode 100644 index 296fc7bc97..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_file_type_metadata.py +++ /dev/null @@ -1,108 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from rapidata.api_client.models.file_type import FileType -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineFileTypeMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineFileTypeMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - file_type: FileType = Field(alias="fileType") - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "fileType", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['FileTypeMetadata']): - raise ValueError("must be one of enum values ('FileTypeMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineFileTypeMetadata 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 IPipelineMetadataPipelineFileTypeMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "fileType": obj.get("fileType"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_image_dimension_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_image_dimension_metadata.py deleted file mode 100644 index cb772da66e..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_image_dimension_metadata.py +++ /dev/null @@ -1,109 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List, Optional -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineImageDimensionMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineImageDimensionMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - height: Optional[StrictInt] = None - width: Optional[StrictInt] = None - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "height", "width", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['ImageDimensionMetadata']): - raise ValueError("must be one of enum values ('ImageDimensionMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineImageDimensionMetadata 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 IPipelineMetadataPipelineImageDimensionMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "height": obj.get("height"), - "width": obj.get("width"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_location_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_location_metadata.py deleted file mode 100644 index fb6622fbab..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_location_metadata.py +++ /dev/null @@ -1,109 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictFloat, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List, Optional, Union -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineLocationMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineLocationMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - x: Optional[Union[StrictFloat, StrictInt]] = None - y: Optional[Union[StrictFloat, StrictInt]] = None - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "x", "y", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['LocationMetadata']): - raise ValueError("must be one of enum values ('LocationMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineLocationMetadata 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 IPipelineMetadataPipelineLocationMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "x": obj.get("x"), - "y": obj.get("y"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_original_filename_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_original_filename_metadata.py deleted file mode 100644 index 1c10bb4796..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_original_filename_metadata.py +++ /dev/null @@ -1,107 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineOriginalFilenameMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineOriginalFilenameMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - original_filename: StrictStr = Field(alias="originalFilename") - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "originalFilename", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['OriginalFilenameMetadata']): - raise ValueError("must be one of enum values ('OriginalFilenameMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineOriginalFilenameMetadata 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 IPipelineMetadataPipelineOriginalFilenameMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "originalFilename": obj.get("originalFilename"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_source_url_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_source_url_metadata.py deleted file mode 100644 index de49dbfc29..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_source_url_metadata.py +++ /dev/null @@ -1,107 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineSourceUrlMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineSourceUrlMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - url: StrictStr - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "url", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['SourceUrlMetadata']): - raise ValueError("must be one of enum values ('SourceUrlMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineSourceUrlMetadata 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 IPipelineMetadataPipelineSourceUrlMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "url": obj.get("url"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_streams_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_streams_metadata.py deleted file mode 100644 index 80e7ab1a31..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_streams_metadata.py +++ /dev/null @@ -1,111 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, field_validator -from typing import Any, ClassVar, Dict, List, Optional -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineStreamsMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineStreamsMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - has_audio: Optional[StrictBool] = Field(default=None, alias="hasAudio") - has_video: Optional[StrictBool] = Field(default=None, alias="hasVideo") - has_subtitles: Optional[StrictBool] = Field(default=None, alias="hasSubtitles") - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "hasAudio", "hasVideo", "hasSubtitles", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['StreamsMetadata']): - raise ValueError("must be one of enum values ('StreamsMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineStreamsMetadata 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 IPipelineMetadataPipelineStreamsMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "hasAudio": obj.get("hasAudio"), - "hasVideo": obj.get("hasVideo"), - "hasSubtitles": obj.get("hasSubtitles"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_text_metadata.py b/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_text_metadata.py deleted file mode 100644 index 7573faa3e7..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_metadata_pipeline_text_metadata.py +++ /dev/null @@ -1,112 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineMetadataPipelineTextMetadata(LazyValidatedModel): - """ - IPipelineMetadataPipelineTextMetadata - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - text: Optional[StrictStr] = None - visibilities: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "text", "visibilities"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['TextMetadata']): - raise ValueError("must be one of enum values ('TextMetadata')") - return value - - @field_validator('visibilities') - def visibilities_validate_enum(cls, value): - """Validates the enum""" - for i in value: - if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']): - raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineMetadataPipelineTextMetadata 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, - ) - # set to None if text (nullable) is None - # and model_fields_set contains the field - if self.text is None and "text" in self.model_fields_set: - _dict['text'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IPipelineMetadataPipelineTextMetadata from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "text": obj.get("text"), - "visibilities": obj.get("visibilities") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_pair_maker_config.py b/src/rapidata/api_client/models/i_pipeline_pair_maker_config.py deleted file mode 100644 index cdb031a403..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_pair_maker_config.py +++ /dev/null @@ -1,137 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -from __future__ import annotations -import json -import pprint -from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator -from typing import Any, List, Optional -from rapidata.api_client.models.i_pipeline_pair_maker_config_pipeline_full_permutation_pair_maker_config import IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig -from rapidata.api_client.models.i_pipeline_pair_maker_config_pipeline_online_pair_maker_config import IPipelinePairMakerConfigPipelineOnlinePairMakerConfig -from pydantic import StrictStr, Field -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Union, List, Set, Optional, Dict -from typing_extensions import Literal, Self - -IPIPELINEPAIRMAKERCONFIG_ONE_OF_SCHEMAS = ["IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig", "IPipelinePairMakerConfigPipelineOnlinePairMakerConfig"] - -class IPipelinePairMakerConfig(LazyValidatedModel): - """ - IPipelinePairMakerConfig - """ - # data type: IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig - oneof_schema_1_validator: Optional[IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig] = None - # data type: IPipelinePairMakerConfigPipelineOnlinePairMakerConfig - oneof_schema_2_validator: Optional[IPipelinePairMakerConfigPipelineOnlinePairMakerConfig] = None - actual_instance: Optional[Union[IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig, IPipelinePairMakerConfigPipelineOnlinePairMakerConfig]] = None - one_of_schemas: Set[str] = { "IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig", "IPipelinePairMakerConfigPipelineOnlinePairMakerConfig" } - - # model_config is inherited from LazyValidatedModel - - - discriminator_value_class_map: Dict[str, str] = { - } - - def __init__(self, *args, **kwargs) -> None: - if args: - if len(args) > 1: - raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") - if kwargs: - raise ValueError("If a position argument is used, keyword arguments cannot be used.") - super().__init__(actual_instance=args[0]) - else: - super().__init__(**kwargs) - - @field_validator('actual_instance') - def actual_instance_must_validate_oneof(cls, v): - instance = IPipelinePairMakerConfig.model_construct() - error_messages = [] - match = 0 - # validate data type: IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig - if not isinstance(v, IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig`") - else: - match += 1 - # validate data type: IPipelinePairMakerConfigPipelineOnlinePairMakerConfig - if not isinstance(v, IPipelinePairMakerConfigPipelineOnlinePairMakerConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelinePairMakerConfigPipelineOnlinePairMakerConfig`") - else: - match += 1 - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in IPipelinePairMakerConfig with oneOf schemas: IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig, IPipelinePairMakerConfigPipelineOnlinePairMakerConfig. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when setting `actual_instance` in IPipelinePairMakerConfig with oneOf schemas: IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig, IPipelinePairMakerConfigPipelineOnlinePairMakerConfig. Details: " + ", ".join(error_messages)) - else: - return v - - @classmethod - def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: - return cls.from_json(json.dumps(obj)) - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Returns the object represented by the json string""" - instance = cls.model_construct() - error_messages = [] - match = 0 - - # deserialize data into IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig - try: - instance.actual_instance = IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelinePairMakerConfigPipelineOnlinePairMakerConfig - try: - instance.actual_instance = IPipelinePairMakerConfigPipelineOnlinePairMakerConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into IPipelinePairMakerConfig with oneOf schemas: IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig, IPipelinePairMakerConfigPipelineOnlinePairMakerConfig. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when deserializing the JSON string into IPipelinePairMakerConfig with oneOf schemas: IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig, IPipelinePairMakerConfigPipelineOnlinePairMakerConfig. Details: " + ", ".join(error_messages)) - else: - return instance - - def to_json(self) -> str: - """Returns the JSON representation of the actual instance""" - if self.actual_instance is None: - return "null" - - if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): - return self.actual_instance.to_json() - else: - return json.dumps(self.actual_instance) - - def to_dict(self) -> Optional[Union[Dict[str, Any], IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig, IPipelinePairMakerConfigPipelineOnlinePairMakerConfig]]: - """Returns the dict representation of the actual instance""" - if self.actual_instance is None: - return None - - if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): - return self.actual_instance.to_dict() - else: - # primitive type - return self.actual_instance - - def to_str(self) -> str: - """Returns the string representation of the actual instance""" - return pprint.pformat(self.model_dump()) - - diff --git a/src/rapidata/api_client/models/i_pipeline_pair_maker_config_pipeline_full_permutation_pair_maker_config.py b/src/rapidata/api_client/models/i_pipeline_pair_maker_config_pipeline_full_permutation_pair_maker_config.py deleted file mode 100644 index c6cc709254..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_pair_maker_config_pipeline_full_permutation_pair_maker_config.py +++ /dev/null @@ -1,95 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig(LazyValidatedModel): - """ - IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - __properties: ClassVar[List[str]] = ["_t"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['FullPermutationPairMakerConfig']): - raise ValueError("must be one of enum values ('FullPermutationPairMakerConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig 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 IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_pair_maker_config_pipeline_online_pair_maker_config.py b/src/rapidata/api_client/models/i_pipeline_pair_maker_config_pipeline_online_pair_maker_config.py deleted file mode 100644 index 85ca586287..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_pair_maker_config_pipeline_online_pair_maker_config.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictFloat, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List, Union -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelinePairMakerConfigPipelineOnlinePairMakerConfig(LazyValidatedModel): - """ - IPipelinePairMakerConfigPipelineOnlinePairMakerConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - random_matches_ratio: Union[StrictFloat, StrictInt] = Field(alias="randomMatchesRatio") - total_comparison_budget: StrictInt = Field(alias="totalComparisonBudget") - __properties: ClassVar[List[str]] = ["_t", "randomMatchesRatio", "totalComparisonBudget"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['OnlinePairMakerConfig']): - raise ValueError("must be one of enum values ('OnlinePairMakerConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelinePairMakerConfigPipelineOnlinePairMakerConfig 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 IPipelinePairMakerConfigPipelineOnlinePairMakerConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "randomMatchesRatio": obj.get("randomMatchesRatio"), - "totalComparisonBudget": obj.get("totalComparisonBudget") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_ranking_config.py b/src/rapidata/api_client/models/i_pipeline_ranking_config.py deleted file mode 100644 index 24cc3e23f6..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_ranking_config.py +++ /dev/null @@ -1,137 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -from __future__ import annotations -import json -import pprint -from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator -from typing import Any, List, Optional -from rapidata.api_client.models.i_pipeline_ranking_config_pipeline_bradley_terry_ranking_config import IPipelineRankingConfigPipelineBradleyTerryRankingConfig -from rapidata.api_client.models.i_pipeline_ranking_config_pipeline_elo_ranking_config import IPipelineRankingConfigPipelineEloRankingConfig -from pydantic import StrictStr, Field -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Union, List, Set, Optional, Dict -from typing_extensions import Literal, Self - -IPIPELINERANKINGCONFIG_ONE_OF_SCHEMAS = ["IPipelineRankingConfigPipelineBradleyTerryRankingConfig", "IPipelineRankingConfigPipelineEloRankingConfig"] - -class IPipelineRankingConfig(LazyValidatedModel): - """ - IPipelineRankingConfig - """ - # data type: IPipelineRankingConfigPipelineBradleyTerryRankingConfig - oneof_schema_1_validator: Optional[IPipelineRankingConfigPipelineBradleyTerryRankingConfig] = None - # data type: IPipelineRankingConfigPipelineEloRankingConfig - oneof_schema_2_validator: Optional[IPipelineRankingConfigPipelineEloRankingConfig] = None - actual_instance: Optional[Union[IPipelineRankingConfigPipelineBradleyTerryRankingConfig, IPipelineRankingConfigPipelineEloRankingConfig]] = None - one_of_schemas: Set[str] = { "IPipelineRankingConfigPipelineBradleyTerryRankingConfig", "IPipelineRankingConfigPipelineEloRankingConfig" } - - # model_config is inherited from LazyValidatedModel - - - discriminator_value_class_map: Dict[str, str] = { - } - - def __init__(self, *args, **kwargs) -> None: - if args: - if len(args) > 1: - raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") - if kwargs: - raise ValueError("If a position argument is used, keyword arguments cannot be used.") - super().__init__(actual_instance=args[0]) - else: - super().__init__(**kwargs) - - @field_validator('actual_instance') - def actual_instance_must_validate_oneof(cls, v): - instance = IPipelineRankingConfig.model_construct() - error_messages = [] - match = 0 - # validate data type: IPipelineRankingConfigPipelineBradleyTerryRankingConfig - if not isinstance(v, IPipelineRankingConfigPipelineBradleyTerryRankingConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineRankingConfigPipelineBradleyTerryRankingConfig`") - else: - match += 1 - # validate data type: IPipelineRankingConfigPipelineEloRankingConfig - if not isinstance(v, IPipelineRankingConfigPipelineEloRankingConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IPipelineRankingConfigPipelineEloRankingConfig`") - else: - match += 1 - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in IPipelineRankingConfig with oneOf schemas: IPipelineRankingConfigPipelineBradleyTerryRankingConfig, IPipelineRankingConfigPipelineEloRankingConfig. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when setting `actual_instance` in IPipelineRankingConfig with oneOf schemas: IPipelineRankingConfigPipelineBradleyTerryRankingConfig, IPipelineRankingConfigPipelineEloRankingConfig. Details: " + ", ".join(error_messages)) - else: - return v - - @classmethod - def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: - return cls.from_json(json.dumps(obj)) - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Returns the object represented by the json string""" - instance = cls.model_construct() - error_messages = [] - match = 0 - - # deserialize data into IPipelineRankingConfigPipelineBradleyTerryRankingConfig - try: - instance.actual_instance = IPipelineRankingConfigPipelineBradleyTerryRankingConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IPipelineRankingConfigPipelineEloRankingConfig - try: - instance.actual_instance = IPipelineRankingConfigPipelineEloRankingConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into IPipelineRankingConfig with oneOf schemas: IPipelineRankingConfigPipelineBradleyTerryRankingConfig, IPipelineRankingConfigPipelineEloRankingConfig. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when deserializing the JSON string into IPipelineRankingConfig with oneOf schemas: IPipelineRankingConfigPipelineBradleyTerryRankingConfig, IPipelineRankingConfigPipelineEloRankingConfig. Details: " + ", ".join(error_messages)) - else: - return instance - - def to_json(self) -> str: - """Returns the JSON representation of the actual instance""" - if self.actual_instance is None: - return "null" - - if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): - return self.actual_instance.to_json() - else: - return json.dumps(self.actual_instance) - - def to_dict(self) -> Optional[Union[Dict[str, Any], IPipelineRankingConfigPipelineBradleyTerryRankingConfig, IPipelineRankingConfigPipelineEloRankingConfig]]: - """Returns the dict representation of the actual instance""" - if self.actual_instance is None: - return None - - if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): - return self.actual_instance.to_dict() - else: - # primitive type - return self.actual_instance - - def to_str(self) -> str: - """Returns the string representation of the actual instance""" - return pprint.pformat(self.model_dump()) - - diff --git a/src/rapidata/api_client/models/i_pipeline_ranking_config_pipeline_bradley_terry_ranking_config.py b/src/rapidata/api_client/models/i_pipeline_ranking_config_pipeline_bradley_terry_ranking_config.py deleted file mode 100644 index 6ef13fe709..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_ranking_config_pipeline_bradley_terry_ranking_config.py +++ /dev/null @@ -1,97 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineRankingConfigPipelineBradleyTerryRankingConfig(LazyValidatedModel): - """ - IPipelineRankingConfigPipelineBradleyTerryRankingConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - starting_score: StrictInt = Field(alias="startingScore") - __properties: ClassVar[List[str]] = ["_t", "startingScore"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['BradleyTerryRankingConfig']): - raise ValueError("must be one of enum values ('BradleyTerryRankingConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineRankingConfigPipelineBradleyTerryRankingConfig 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 IPipelineRankingConfigPipelineBradleyTerryRankingConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "startingScore": obj.get("startingScore") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_ranking_config_pipeline_elo_ranking_config.py b/src/rapidata/api_client/models/i_pipeline_ranking_config_pipeline_elo_ranking_config.py deleted file mode 100644 index 7a3b01b4b0..0000000000 --- a/src/rapidata/api_client/models/i_pipeline_ranking_config_pipeline_elo_ranking_config.py +++ /dev/null @@ -1,101 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IPipelineRankingConfigPipelineEloRankingConfig(LazyValidatedModel): - """ - IPipelineRankingConfigPipelineEloRankingConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - starting_elo: StrictInt = Field(alias="startingElo") - k_factor: StrictInt = Field(alias="kFactor") - scaling_factor: StrictInt = Field(alias="scalingFactor") - __properties: ClassVar[List[str]] = ["_t", "startingElo", "kFactor", "scalingFactor"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['EloRankingConfig']): - raise ValueError("must be one of enum values ('EloRankingConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IPipelineRankingConfigPipelineEloRankingConfig 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 IPipelineRankingConfigPipelineEloRankingConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "startingElo": obj.get("startingElo"), - "kFactor": obj.get("kFactor"), - "scalingFactor": obj.get("scalingFactor") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_pipeline_step.py b/src/rapidata/api_client/models/i_pipeline_step.py index 9b27f77332..8f3f63be61 100644 --- a/src/rapidata/api_client/models/i_pipeline_step.py +++ b/src/rapidata/api_client/models/i_pipeline_step.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pipeline_step_dataset_evaluation_step.py b/src/rapidata/api_client/models/i_pipeline_step_dataset_evaluation_step.py index 83f253bd72..7562a06eff 100644 --- a/src/rapidata/api_client/models/i_pipeline_step_dataset_evaluation_step.py +++ b/src/rapidata/api_client/models/i_pipeline_step_dataset_evaluation_step.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pipeline_step_send_completion_mail_step.py b/src/rapidata/api_client/models/i_pipeline_step_send_completion_mail_step.py index e8d4157be2..0aa91fb597 100644 --- a/src/rapidata/api_client/models/i_pipeline_step_send_completion_mail_step.py +++ b/src/rapidata/api_client/models/i_pipeline_step_send_completion_mail_step.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pipeline_step_workflow_aggregation_step.py b/src/rapidata/api_client/models/i_pipeline_step_workflow_aggregation_step.py index 47002a3ed4..a1dc42d68c 100644 --- a/src/rapidata/api_client/models/i_pipeline_step_workflow_aggregation_step.py +++ b/src/rapidata/api_client/models/i_pipeline_step_workflow_aggregation_step.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_pipeline_step_workflow_labeling_step.py b/src/rapidata/api_client/models/i_pipeline_step_workflow_labeling_step.py index f2e7e7aa09..11bde1276e 100644 --- a/src/rapidata/api_client/models/i_pipeline_step_workflow_labeling_step.py +++ b/src/rapidata/api_client/models/i_pipeline_step_workflow_labeling_step.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_action.py b/src/rapidata/api_client/models/i_program_action.py index d4b01ff248..117302750d 100644 --- a/src/rapidata/api_client/models/i_program_action.py +++ b/src/rapidata/api_client/models/i_program_action.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_action_complete_action.py b/src/rapidata/api_client/models/i_program_action_complete_action.py index dc0ef27733..b7d19092ef 100644 --- a/src/rapidata/api_client/models/i_program_action_complete_action.py +++ b/src/rapidata/api_client/models/i_program_action_complete_action.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_action_serve_rapid_action.py b/src/rapidata/api_client/models/i_program_action_serve_rapid_action.py index 17b99e1acd..e8f3175cb8 100644 --- a/src/rapidata/api_client/models/i_program_action_serve_rapid_action.py +++ b/src/rapidata/api_client/models/i_program_action_serve_rapid_action.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_node.py b/src/rapidata/api_client/models/i_program_node.py index 63f48024c9..d3d95308b4 100644 --- a/src/rapidata/api_client/models/i_program_node.py +++ b/src/rapidata/api_client/models/i_program_node.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_node_action_node.py b/src/rapidata/api_client/models/i_program_node_action_node.py index 4a3e148c7f..85635af682 100644 --- a/src/rapidata/api_client/models/i_program_node_action_node.py +++ b/src/rapidata/api_client/models/i_program_node_action_node.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_node_cases_node.py b/src/rapidata/api_client/models/i_program_node_cases_node.py index bba801c50c..18fe5a8e37 100644 --- a/src/rapidata/api_client/models/i_program_node_cases_node.py +++ b/src/rapidata/api_client/models/i_program_node_cases_node.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_node_weighted_split_node.py b/src/rapidata/api_client/models/i_program_node_weighted_split_node.py index 684ee1dfaf..5ede275971 100644 --- a/src/rapidata/api_client/models/i_program_node_weighted_split_node.py +++ b/src/rapidata/api_client/models/i_program_node_weighted_split_node.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_predicate.py b/src/rapidata/api_client/models/i_program_predicate.py index 6a244d0324..6013a184da 100644 --- a/src/rapidata/api_client/models/i_program_predicate.py +++ b/src/rapidata/api_client/models/i_program_predicate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_predicate_accuracy_predicate.py b/src/rapidata/api_client/models/i_program_predicate_accuracy_predicate.py index b38044a886..f8e8dd5271 100644 --- a/src/rapidata/api_client/models/i_program_predicate_accuracy_predicate.py +++ b/src/rapidata/api_client/models/i_program_predicate_accuracy_predicate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_predicate_answered_count_predicate.py b/src/rapidata/api_client/models/i_program_predicate_answered_count_predicate.py index f9f12cfa83..71ec84cfff 100644 --- a/src/rapidata/api_client/models/i_program_predicate_answered_count_predicate.py +++ b/src/rapidata/api_client/models/i_program_predicate_answered_count_predicate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_predicate_consecutive_correct_predicate.py b/src/rapidata/api_client/models/i_program_predicate_consecutive_correct_predicate.py index b3bcfe0459..2602677264 100644 --- a/src/rapidata/api_client/models/i_program_predicate_consecutive_correct_predicate.py +++ b/src/rapidata/api_client/models/i_program_predicate_consecutive_correct_predicate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_predicate_consecutive_incorrect_predicate.py b/src/rapidata/api_client/models/i_program_predicate_consecutive_incorrect_predicate.py index 325b96e599..0bdba13b77 100644 --- a/src/rapidata/api_client/models/i_program_predicate_consecutive_incorrect_predicate.py +++ b/src/rapidata/api_client/models/i_program_predicate_consecutive_incorrect_predicate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_predicate_correct_count_predicate.py b/src/rapidata/api_client/models/i_program_predicate_correct_count_predicate.py index 3025af6b22..17e6a5a971 100644 --- a/src/rapidata/api_client/models/i_program_predicate_correct_count_predicate.py +++ b/src/rapidata/api_client/models/i_program_predicate_correct_count_predicate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_predicate_time_elapsed_predicate.py b/src/rapidata/api_client/models/i_program_predicate_time_elapsed_predicate.py index 5931ffbc0c..c35994d818 100644 --- a/src/rapidata/api_client/models/i_program_predicate_time_elapsed_predicate.py +++ b/src/rapidata/api_client/models/i_program_predicate_time_elapsed_predicate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_predicate_user_attribute_predicate.py b/src/rapidata/api_client/models/i_program_predicate_user_attribute_predicate.py index 002b070b6a..af5ec0a185 100644 --- a/src/rapidata/api_client/models/i_program_predicate_user_attribute_predicate.py +++ b/src/rapidata/api_client/models/i_program_predicate_user_attribute_predicate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_program_predicate_user_score_predicate.py b/src/rapidata/api_client/models/i_program_predicate_user_score_predicate.py index 9c162d8f46..ba8f8e0acd 100644 --- a/src/rapidata/api_client/models/i_program_predicate_user_score_predicate.py +++ b/src/rapidata/api_client/models/i_program_predicate_user_score_predicate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_ranking_config.py b/src/rapidata/api_client/models/i_ranking_config.py index 3bc431d177..25aa59bf5d 100644 --- a/src/rapidata/api_client/models/i_ranking_config.py +++ b/src/rapidata/api_client/models/i_ranking_config.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_ranking_config_bradley_terry_ranking_config.py b/src/rapidata/api_client/models/i_ranking_config_bradley_terry_ranking_config.py index 870b7e3cdc..7ca3987d5c 100644 --- a/src/rapidata/api_client/models/i_ranking_config_bradley_terry_ranking_config.py +++ b/src/rapidata/api_client/models/i_ranking_config_bradley_terry_ranking_config.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_ranking_config_elo_config.py b/src/rapidata/api_client/models/i_ranking_config_elo_config.py index ca4794fcf1..8e4e4187e0 100644 --- a/src/rapidata/api_client/models/i_ranking_config_elo_config.py +++ b/src/rapidata/api_client/models/i_ranking_config_elo_config.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid.py b/src/rapidata/api_client/models/i_rapid.py index 7bb33364a2..75fcdf0886 100644 --- a/src/rapidata/api_client/models/i_rapid.py +++ b/src/rapidata/api_client/models/i_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_attach_category_rapid.py b/src/rapidata/api_client/models/i_rapid_attach_category_rapid.py index 68e99bbf52..4aceabd8a4 100644 --- a/src/rapidata/api_client/models/i_rapid_attach_category_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_attach_category_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint.py index 8ddea4e743..9caac252f0 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_attach_category_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_attach_category_rapid_blueprint.py index d2c9c09e69..27c2ac0a7a 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_attach_category_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_attach_category_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_bounding_box_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_bounding_box_rapid_blueprint.py index 111901f82d..53211c8f90 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_bounding_box_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_bounding_box_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_compare_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_compare_rapid_blueprint.py index 1b836904dc..dfd2962a5c 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_compare_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_compare_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_free_text_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_free_text_rapid_blueprint.py index 2fb19b9bcf..c5a9d095a8 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_free_text_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_free_text_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_line_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_line_rapid_blueprint.py index d9f115b773..69a9295592 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_line_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_line_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_locate_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_locate_rapid_blueprint.py index 9a549a4d2c..e02a6c65cc 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_locate_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_locate_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_named_entity_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_named_entity_rapid_blueprint.py index 7473987b0c..92791ee7f6 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_named_entity_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_named_entity_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_polygon_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_polygon_rapid_blueprint.py index 11078f3521..910ba3c251 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_polygon_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_polygon_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_scrub_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_scrub_rapid_blueprint.py index ec729ceaec..5090adfe25 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_scrub_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_scrub_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_blueprint_transcription_rapid_blueprint.py b/src/rapidata/api_client/models/i_rapid_blueprint_transcription_rapid_blueprint.py index 5a68f21c7f..d5bc62ce43 100644 --- a/src/rapidata/api_client/models/i_rapid_blueprint_transcription_rapid_blueprint.py +++ b/src/rapidata/api_client/models/i_rapid_blueprint_transcription_rapid_blueprint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_bounding_box_rapid.py b/src/rapidata/api_client/models/i_rapid_bounding_box_rapid.py index 11da1ff38b..41f4a25ef3 100644 --- a/src/rapidata/api_client/models/i_rapid_bounding_box_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_bounding_box_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_compare_rapid.py b/src/rapidata/api_client/models/i_rapid_compare_rapid.py index f53591365d..d8b3f7fe3c 100644 --- a/src/rapidata/api_client/models/i_rapid_compare_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_compare_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_free_text_rapid.py b/src/rapidata/api_client/models/i_rapid_free_text_rapid.py index b8a84bec7c..a2b9c99410 100644 --- a/src/rapidata/api_client/models/i_rapid_free_text_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_free_text_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_line_rapid.py b/src/rapidata/api_client/models/i_rapid_line_rapid.py index d06e0139eb..959aa3ce87 100644 --- a/src/rapidata/api_client/models/i_rapid_line_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_line_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_locate_rapid.py b/src/rapidata/api_client/models/i_rapid_locate_rapid.py index d67f7ffd05..652bca0b60 100644 --- a/src/rapidata/api_client/models/i_rapid_locate_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_locate_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_named_entity_rapid.py b/src/rapidata/api_client/models/i_rapid_named_entity_rapid.py index bbe4521547..3f866b0050 100644 --- a/src/rapidata/api_client/models/i_rapid_named_entity_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_named_entity_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload.py b/src/rapidata/api_client/models/i_rapid_payload.py index e26691adc7..5316ae7c36 100644 --- a/src/rapidata/api_client/models/i_rapid_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_bounding_box_payload.py b/src/rapidata/api_client/models/i_rapid_payload_bounding_box_payload.py index 3211cdac76..50524a08f9 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_bounding_box_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_bounding_box_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_classify_payload.py b/src/rapidata/api_client/models/i_rapid_payload_classify_payload.py index 676a94c0e7..cb50057968 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_classify_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_classify_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_compare_payload.py b/src/rapidata/api_client/models/i_rapid_payload_compare_payload.py index c4a4c02691..03e5ff59cd 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_compare_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_compare_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_free_text_payload.py b/src/rapidata/api_client/models/i_rapid_payload_free_text_payload.py index 431bf96a1f..c529dea3b3 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_free_text_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_free_text_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_line_payload.py b/src/rapidata/api_client/models/i_rapid_payload_line_payload.py index 867ec8ad2b..83c8a322e9 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_line_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_line_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_locate_payload.py b/src/rapidata/api_client/models/i_rapid_payload_locate_payload.py index 8f13fe4c84..c5f59a7bce 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_locate_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_locate_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_named_entity_payload.py b/src/rapidata/api_client/models/i_rapid_payload_named_entity_payload.py index 157c851493..d9033837c8 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_named_entity_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_named_entity_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_polygon_payload.py b/src/rapidata/api_client/models/i_rapid_payload_polygon_payload.py index 0f3d7fd78a..9eff3ff1f0 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_polygon_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_polygon_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_scrub_payload.py b/src/rapidata/api_client/models/i_rapid_payload_scrub_payload.py index 99bc4cd597..e560c9044f 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_scrub_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_scrub_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_payload_transcription_payload.py b/src/rapidata/api_client/models/i_rapid_payload_transcription_payload.py index 06006dcbc6..630d1f61b2 100644 --- a/src/rapidata/api_client/models/i_rapid_payload_transcription_payload.py +++ b/src/rapidata/api_client/models/i_rapid_payload_transcription_payload.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_polygon_rapid.py b/src/rapidata/api_client/models/i_rapid_polygon_rapid.py index 7467ce0e9a..e287875c80 100644 --- a/src/rapidata/api_client/models/i_rapid_polygon_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_polygon_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result.py b/src/rapidata/api_client/models/i_rapid_result.py index 5d4ab7dbc6..50160e30fe 100644 --- a/src/rapidata/api_client/models/i_rapid_result.py +++ b/src/rapidata/api_client/models/i_rapid_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_attach_category_result.py b/src/rapidata/api_client/models/i_rapid_result_attach_category_result.py index f316006b8b..98c5869f88 100644 --- a/src/rapidata/api_client/models/i_rapid_result_attach_category_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_attach_category_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_bounding_box_result.py b/src/rapidata/api_client/models/i_rapid_result_bounding_box_result.py index 62efd558c3..811ca4da8a 100644 --- a/src/rapidata/api_client/models/i_rapid_result_bounding_box_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_bounding_box_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_compare_result.py b/src/rapidata/api_client/models/i_rapid_result_compare_result.py index 4ada2a8fb6..88d7bcbf0e 100644 --- a/src/rapidata/api_client/models/i_rapid_result_compare_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_compare_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_free_text_result.py b/src/rapidata/api_client/models/i_rapid_result_free_text_result.py index c6572b5e96..5791a9940b 100644 --- a/src/rapidata/api_client/models/i_rapid_result_free_text_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_free_text_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_line_result.py b/src/rapidata/api_client/models/i_rapid_result_line_result.py index d4d78357ff..e1d44e693d 100644 --- a/src/rapidata/api_client/models/i_rapid_result_line_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_line_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_locate_result.py b/src/rapidata/api_client/models/i_rapid_result_locate_result.py index 97fd91e6c1..b10c48a483 100644 --- a/src/rapidata/api_client/models/i_rapid_result_locate_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_locate_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_named_entity_result.py b/src/rapidata/api_client/models/i_rapid_result_named_entity_result.py index f7ecd75d50..e42705d919 100644 --- a/src/rapidata/api_client/models/i_rapid_result_named_entity_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_named_entity_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_polygon_result.py b/src/rapidata/api_client/models/i_rapid_result_polygon_result.py index 91d5c32311..ffa80e5fef 100644 --- a/src/rapidata/api_client/models/i_rapid_result_polygon_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_polygon_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_scrub_result.py b/src/rapidata/api_client/models/i_rapid_result_scrub_result.py index c1db7f85b6..82bc510777 100644 --- a/src/rapidata/api_client/models/i_rapid_result_scrub_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_scrub_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_skip_result.py b/src/rapidata/api_client/models/i_rapid_result_skip_result.py index be98db3596..765746f4d7 100644 --- a/src/rapidata/api_client/models/i_rapid_result_skip_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_skip_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_result_transcription_result.py b/src/rapidata/api_client/models/i_rapid_result_transcription_result.py index c98f212874..9112c9446a 100644 --- a/src/rapidata/api_client/models/i_rapid_result_transcription_result.py +++ b/src/rapidata/api_client/models/i_rapid_result_transcription_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_scrub_rapid.py b/src/rapidata/api_client/models/i_rapid_scrub_rapid.py index edb07e0fd4..ef0e4d8883 100644 --- a/src/rapidata/api_client/models/i_rapid_scrub_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_scrub_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_rapid_transcription_rapid.py b/src/rapidata/api_client/models/i_rapid_transcription_rapid.py index fa34f46ab7..f7127c0c37 100644 --- a/src/rapidata/api_client/models/i_rapid_transcription_rapid.py +++ b/src/rapidata/api_client/models/i_rapid_transcription_rapid.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee.py b/src/rapidata/api_client/models/i_referee.py index 408886b5a3..6bda455d45 100644 --- a/src/rapidata/api_client/models/i_referee.py +++ b/src/rapidata/api_client/models/i_referee.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee_budget_referee.py b/src/rapidata/api_client/models/i_referee_budget_referee.py index 0cc0ee7dff..e0fd0c1629 100644 --- a/src/rapidata/api_client/models/i_referee_budget_referee.py +++ b/src/rapidata/api_client/models/i_referee_budget_referee.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee_config.py b/src/rapidata/api_client/models/i_referee_config.py deleted file mode 100644 index 5cbea34ade..0000000000 --- a/src/rapidata/api_client/models/i_referee_config.py +++ /dev/null @@ -1,179 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -from __future__ import annotations -import json -import pprint -from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator -from typing import Any, List, Optional -from rapidata.api_client.models.i_referee_config_budget_referee_config import IRefereeConfigBudgetRefereeConfig -from rapidata.api_client.models.i_referee_config_naive_referee_config import IRefereeConfigNaiveRefereeConfig -from rapidata.api_client.models.i_referee_config_never_ending_referee_config import IRefereeConfigNeverEndingRefereeConfig -from rapidata.api_client.models.i_referee_config_probabilistic_attach_category_referee_config import IRefereeConfigProbabilisticAttachCategoryRefereeConfig -from rapidata.api_client.models.i_referee_config_quorum_referee_config import IRefereeConfigQuorumRefereeConfig -from pydantic import StrictStr, Field -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Union, List, Set, Optional, Dict -from typing_extensions import Literal, Self - -IREFEREECONFIG_ONE_OF_SCHEMAS = ["IRefereeConfigBudgetRefereeConfig", "IRefereeConfigNaiveRefereeConfig", "IRefereeConfigNeverEndingRefereeConfig", "IRefereeConfigProbabilisticAttachCategoryRefereeConfig", "IRefereeConfigQuorumRefereeConfig"] - -class IRefereeConfig(LazyValidatedModel): - """ - IRefereeConfig - """ - # data type: IRefereeConfigBudgetRefereeConfig - oneof_schema_1_validator: Optional[IRefereeConfigBudgetRefereeConfig] = None - # data type: IRefereeConfigNaiveRefereeConfig - oneof_schema_2_validator: Optional[IRefereeConfigNaiveRefereeConfig] = None - # data type: IRefereeConfigNeverEndingRefereeConfig - oneof_schema_3_validator: Optional[IRefereeConfigNeverEndingRefereeConfig] = None - # data type: IRefereeConfigProbabilisticAttachCategoryRefereeConfig - oneof_schema_4_validator: Optional[IRefereeConfigProbabilisticAttachCategoryRefereeConfig] = None - # data type: IRefereeConfigQuorumRefereeConfig - oneof_schema_5_validator: Optional[IRefereeConfigQuorumRefereeConfig] = None - actual_instance: Optional[Union[IRefereeConfigBudgetRefereeConfig, IRefereeConfigNaiveRefereeConfig, IRefereeConfigNeverEndingRefereeConfig, IRefereeConfigProbabilisticAttachCategoryRefereeConfig, IRefereeConfigQuorumRefereeConfig]] = None - one_of_schemas: Set[str] = { "IRefereeConfigBudgetRefereeConfig", "IRefereeConfigNaiveRefereeConfig", "IRefereeConfigNeverEndingRefereeConfig", "IRefereeConfigProbabilisticAttachCategoryRefereeConfig", "IRefereeConfigQuorumRefereeConfig" } - - # model_config is inherited from LazyValidatedModel - - - discriminator_value_class_map: Dict[str, str] = { - } - - def __init__(self, *args, **kwargs) -> None: - if args: - if len(args) > 1: - raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") - if kwargs: - raise ValueError("If a position argument is used, keyword arguments cannot be used.") - super().__init__(actual_instance=args[0]) - else: - super().__init__(**kwargs) - - @field_validator('actual_instance') - def actual_instance_must_validate_oneof(cls, v): - instance = IRefereeConfig.model_construct() - error_messages = [] - match = 0 - # validate data type: IRefereeConfigBudgetRefereeConfig - if not isinstance(v, IRefereeConfigBudgetRefereeConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IRefereeConfigBudgetRefereeConfig`") - else: - match += 1 - # validate data type: IRefereeConfigNaiveRefereeConfig - if not isinstance(v, IRefereeConfigNaiveRefereeConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IRefereeConfigNaiveRefereeConfig`") - else: - match += 1 - # validate data type: IRefereeConfigNeverEndingRefereeConfig - if not isinstance(v, IRefereeConfigNeverEndingRefereeConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IRefereeConfigNeverEndingRefereeConfig`") - else: - match += 1 - # validate data type: IRefereeConfigProbabilisticAttachCategoryRefereeConfig - if not isinstance(v, IRefereeConfigProbabilisticAttachCategoryRefereeConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IRefereeConfigProbabilisticAttachCategoryRefereeConfig`") - else: - match += 1 - # validate data type: IRefereeConfigQuorumRefereeConfig - if not isinstance(v, IRefereeConfigQuorumRefereeConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IRefereeConfigQuorumRefereeConfig`") - else: - match += 1 - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in IRefereeConfig with oneOf schemas: IRefereeConfigBudgetRefereeConfig, IRefereeConfigNaiveRefereeConfig, IRefereeConfigNeverEndingRefereeConfig, IRefereeConfigProbabilisticAttachCategoryRefereeConfig, IRefereeConfigQuorumRefereeConfig. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when setting `actual_instance` in IRefereeConfig with oneOf schemas: IRefereeConfigBudgetRefereeConfig, IRefereeConfigNaiveRefereeConfig, IRefereeConfigNeverEndingRefereeConfig, IRefereeConfigProbabilisticAttachCategoryRefereeConfig, IRefereeConfigQuorumRefereeConfig. Details: " + ", ".join(error_messages)) - else: - return v - - @classmethod - def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: - return cls.from_json(json.dumps(obj)) - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Returns the object represented by the json string""" - instance = cls.model_construct() - error_messages = [] - match = 0 - - # deserialize data into IRefereeConfigBudgetRefereeConfig - try: - instance.actual_instance = IRefereeConfigBudgetRefereeConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IRefereeConfigNaiveRefereeConfig - try: - instance.actual_instance = IRefereeConfigNaiveRefereeConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IRefereeConfigNeverEndingRefereeConfig - try: - instance.actual_instance = IRefereeConfigNeverEndingRefereeConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IRefereeConfigProbabilisticAttachCategoryRefereeConfig - try: - instance.actual_instance = IRefereeConfigProbabilisticAttachCategoryRefereeConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IRefereeConfigQuorumRefereeConfig - try: - instance.actual_instance = IRefereeConfigQuorumRefereeConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into IRefereeConfig with oneOf schemas: IRefereeConfigBudgetRefereeConfig, IRefereeConfigNaiveRefereeConfig, IRefereeConfigNeverEndingRefereeConfig, IRefereeConfigProbabilisticAttachCategoryRefereeConfig, IRefereeConfigQuorumRefereeConfig. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when deserializing the JSON string into IRefereeConfig with oneOf schemas: IRefereeConfigBudgetRefereeConfig, IRefereeConfigNaiveRefereeConfig, IRefereeConfigNeverEndingRefereeConfig, IRefereeConfigProbabilisticAttachCategoryRefereeConfig, IRefereeConfigQuorumRefereeConfig. Details: " + ", ".join(error_messages)) - else: - return instance - - def to_json(self) -> str: - """Returns the JSON representation of the actual instance""" - if self.actual_instance is None: - return "null" - - if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): - return self.actual_instance.to_json() - else: - return json.dumps(self.actual_instance) - - def to_dict(self) -> Optional[Union[Dict[str, Any], IRefereeConfigBudgetRefereeConfig, IRefereeConfigNaiveRefereeConfig, IRefereeConfigNeverEndingRefereeConfig, IRefereeConfigProbabilisticAttachCategoryRefereeConfig, IRefereeConfigQuorumRefereeConfig]]: - """Returns the dict representation of the actual instance""" - if self.actual_instance is None: - return None - - if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): - return self.actual_instance.to_dict() - else: - # primitive type - return self.actual_instance - - def to_str(self) -> str: - """Returns the string representation of the actual instance""" - return pprint.pformat(self.model_dump()) - - diff --git a/src/rapidata/api_client/models/i_referee_config_budget_referee_config.py b/src/rapidata/api_client/models/i_referee_config_budget_referee_config.py deleted file mode 100644 index a6cb6b927e..0000000000 --- a/src/rapidata/api_client/models/i_referee_config_budget_referee_config.py +++ /dev/null @@ -1,104 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List, Optional -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IRefereeConfigBudgetRefereeConfig(LazyValidatedModel): - """ - IRefereeConfigBudgetRefereeConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - total_budget: StrictInt = Field(alias="totalBudget") - total_serve_budget: Optional[StrictInt] = Field(default=None, alias="totalServeBudget") - __properties: ClassVar[List[str]] = ["_t", "totalBudget", "totalServeBudget"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['BudgetRefereeConfig']): - raise ValueError("must be one of enum values ('BudgetRefereeConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IRefereeConfigBudgetRefereeConfig 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, - ) - # set to None if total_serve_budget (nullable) is None - # and model_fields_set contains the field - if self.total_serve_budget is None and "total_serve_budget" in self.model_fields_set: - _dict['totalServeBudget'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IRefereeConfigBudgetRefereeConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "totalBudget": obj.get("totalBudget"), - "totalServeBudget": obj.get("totalServeBudget") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_referee_config_naive_referee_config.py b/src/rapidata/api_client/models/i_referee_config_naive_referee_config.py deleted file mode 100644 index 56517cdf7a..0000000000 --- a/src/rapidata/api_client/models/i_referee_config_naive_referee_config.py +++ /dev/null @@ -1,97 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List, Optional -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IRefereeConfigNaiveRefereeConfig(LazyValidatedModel): - """ - IRefereeConfigNaiveRefereeConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - responses_required: Optional[StrictInt] = Field(default=None, alias="responsesRequired") - __properties: ClassVar[List[str]] = ["_t", "responsesRequired"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['NaiveRefereeConfig']): - raise ValueError("must be one of enum values ('NaiveRefereeConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IRefereeConfigNaiveRefereeConfig 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 IRefereeConfigNaiveRefereeConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "responsesRequired": obj.get("responsesRequired") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_referee_config_never_ending_referee_config.py b/src/rapidata/api_client/models/i_referee_config_never_ending_referee_config.py deleted file mode 100644 index d798fe9297..0000000000 --- a/src/rapidata/api_client/models/i_referee_config_never_ending_referee_config.py +++ /dev/null @@ -1,95 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IRefereeConfigNeverEndingRefereeConfig(LazyValidatedModel): - """ - IRefereeConfigNeverEndingRefereeConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - __properties: ClassVar[List[str]] = ["_t"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['NeverEndingRefereeConfig']): - raise ValueError("must be one of enum values ('NeverEndingRefereeConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IRefereeConfigNeverEndingRefereeConfig 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 IRefereeConfigNeverEndingRefereeConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_referee_config_probabilistic_attach_category_referee_config.py b/src/rapidata/api_client/models/i_referee_config_probabilistic_attach_category_referee_config.py deleted file mode 100644 index 396af40319..0000000000 --- a/src/rapidata/api_client/models/i_referee_config_probabilistic_attach_category_referee_config.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictFloat, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List, Union -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IRefereeConfigProbabilisticAttachCategoryRefereeConfig(LazyValidatedModel): - """ - IRefereeConfigProbabilisticAttachCategoryRefereeConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - threshold: Union[StrictFloat, StrictInt] - max_votes: StrictInt = Field(alias="maxVotes") - __properties: ClassVar[List[str]] = ["_t", "threshold", "maxVotes"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['ProbabilisticAttachCategoryRefereeConfig']): - raise ValueError("must be one of enum values ('ProbabilisticAttachCategoryRefereeConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IRefereeConfigProbabilisticAttachCategoryRefereeConfig 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 IRefereeConfigProbabilisticAttachCategoryRefereeConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "threshold": obj.get("threshold"), - "maxVotes": obj.get("maxVotes") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_referee_config_quorum_referee_config.py b/src/rapidata/api_client/models/i_referee_config_quorum_referee_config.py deleted file mode 100644 index 5963fe25b4..0000000000 --- a/src/rapidata/api_client/models/i_referee_config_quorum_referee_config.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IRefereeConfigQuorumRefereeConfig(LazyValidatedModel): - """ - IRefereeConfigQuorumRefereeConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - max_votes: StrictInt = Field(alias="maxVotes") - threshold: StrictInt - __properties: ClassVar[List[str]] = ["_t", "maxVotes", "threshold"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['QuorumRefereeConfig']): - raise ValueError("must be one of enum values ('QuorumRefereeConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IRefereeConfigQuorumRefereeConfig 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 IRefereeConfigQuorumRefereeConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "maxVotes": obj.get("maxVotes"), - "threshold": obj.get("threshold") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_referee_early_stopping_referee.py b/src/rapidata/api_client/models/i_referee_early_stopping_referee.py index b3dc3dcf3b..476e0c430b 100644 --- a/src/rapidata/api_client/models/i_referee_early_stopping_referee.py +++ b/src/rapidata/api_client/models/i_referee_early_stopping_referee.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee_info.py b/src/rapidata/api_client/models/i_referee_info.py index 3df6707a59..7dd6e209f3 100644 --- a/src/rapidata/api_client/models/i_referee_info.py +++ b/src/rapidata/api_client/models/i_referee_info.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee_info_naive_referee_info.py b/src/rapidata/api_client/models/i_referee_info_naive_referee_info.py index e389e64ce9..f9099fbd13 100644 --- a/src/rapidata/api_client/models/i_referee_info_naive_referee_info.py +++ b/src/rapidata/api_client/models/i_referee_info_naive_referee_info.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee_info_never_ending_referee_info.py b/src/rapidata/api_client/models/i_referee_info_never_ending_referee_info.py index fa0b996a84..aff36fcb64 100644 --- a/src/rapidata/api_client/models/i_referee_info_never_ending_referee_info.py +++ b/src/rapidata/api_client/models/i_referee_info_never_ending_referee_info.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee_info_probabilistic_attach_category_referee_info.py b/src/rapidata/api_client/models/i_referee_info_probabilistic_attach_category_referee_info.py index d3e654e689..6e96b42d9b 100644 --- a/src/rapidata/api_client/models/i_referee_info_probabilistic_attach_category_referee_info.py +++ b/src/rapidata/api_client/models/i_referee_info_probabilistic_attach_category_referee_info.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee_info_quorum_referee_info.py b/src/rapidata/api_client/models/i_referee_info_quorum_referee_info.py index 1df0a59356..5d64b8ad41 100644 --- a/src/rapidata/api_client/models/i_referee_info_quorum_referee_info.py +++ b/src/rapidata/api_client/models/i_referee_info_quorum_referee_info.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee_naive_referee.py b/src/rapidata/api_client/models/i_referee_naive_referee.py index fb22bda322..809e8933fe 100644 --- a/src/rapidata/api_client/models/i_referee_naive_referee.py +++ b/src/rapidata/api_client/models/i_referee_naive_referee.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_referee_quorum_referee.py b/src/rapidata/api_client/models/i_referee_quorum_referee.py index 0d83c4e279..aa23337630 100644 --- a/src/rapidata/api_client/models/i_referee_quorum_referee.py +++ b/src/rapidata/api_client/models/i_referee_quorum_referee.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_response_aggregation.py b/src/rapidata/api_client/models/i_response_aggregation.py index 823df93ee9..95304ee9a2 100644 --- a/src/rapidata/api_client/models/i_response_aggregation.py +++ b/src/rapidata/api_client/models/i_response_aggregation.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_response_aggregation_classify_aggregation.py b/src/rapidata/api_client/models/i_response_aggregation_classify_aggregation.py index f15cea2bb4..f934e4820f 100644 --- a/src/rapidata/api_client/models/i_response_aggregation_classify_aggregation.py +++ b/src/rapidata/api_client/models/i_response_aggregation_classify_aggregation.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_response_aggregation_compare_aggregation.py b/src/rapidata/api_client/models/i_response_aggregation_compare_aggregation.py index a8bd842f38..95a4c84652 100644 --- a/src/rapidata/api_client/models/i_response_aggregation_compare_aggregation.py +++ b/src/rapidata/api_client/models/i_response_aggregation_compare_aggregation.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection.py b/src/rapidata/api_client/models/i_selection.py index f76dda697c..ccff97e61e 100644 --- a/src/rapidata/api_client/models/i_selection.py +++ b/src/rapidata/api_client/models/i_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection_ab_test_selection.py b/src/rapidata/api_client/models/i_selection_ab_test_selection.py index 733cffca52..76a312574e 100644 --- a/src/rapidata/api_client/models/i_selection_ab_test_selection.py +++ b/src/rapidata/api_client/models/i_selection_ab_test_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection_capped_selection.py b/src/rapidata/api_client/models/i_selection_capped_selection.py index 38466bb94f..8e4bcd5a39 100644 --- a/src/rapidata/api_client/models/i_selection_capped_selection.py +++ b/src/rapidata/api_client/models/i_selection_capped_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection_conditional_validation_selection.py b/src/rapidata/api_client/models/i_selection_conditional_validation_selection.py index 3d2f7bfcb5..2a30cdaa5f 100644 --- a/src/rapidata/api_client/models/i_selection_conditional_validation_selection.py +++ b/src/rapidata/api_client/models/i_selection_conditional_validation_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection_demographic_selection.py b/src/rapidata/api_client/models/i_selection_demographic_selection.py index 0e044b953d..bef454745f 100644 --- a/src/rapidata/api_client/models/i_selection_demographic_selection.py +++ b/src/rapidata/api_client/models/i_selection_demographic_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection_effort_capped_selection.py b/src/rapidata/api_client/models/i_selection_effort_capped_selection.py index 3d635e9d46..48f582c493 100644 --- a/src/rapidata/api_client/models/i_selection_effort_capped_selection.py +++ b/src/rapidata/api_client/models/i_selection_effort_capped_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection_labeling_selection.py b/src/rapidata/api_client/models/i_selection_labeling_selection.py index 27ef664dce..c23021d5ab 100644 --- a/src/rapidata/api_client/models/i_selection_labeling_selection.py +++ b/src/rapidata/api_client/models/i_selection_labeling_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection_shuffling_selection.py b/src/rapidata/api_client/models/i_selection_shuffling_selection.py index adf40bff15..b4d0181de5 100644 --- a/src/rapidata/api_client/models/i_selection_shuffling_selection.py +++ b/src/rapidata/api_client/models/i_selection_shuffling_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection_static_selection.py b/src/rapidata/api_client/models/i_selection_static_selection.py index f5b01a0cc0..5f51e3be64 100644 --- a/src/rapidata/api_client/models/i_selection_static_selection.py +++ b/src/rapidata/api_client/models/i_selection_static_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_selection_validation_selection.py b/src/rapidata/api_client/models/i_selection_validation_selection.py index 9faeb76f46..59ab84d487 100644 --- a/src/rapidata/api_client/models/i_selection_validation_selection.py +++ b/src/rapidata/api_client/models/i_selection_validation_selection.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter.py b/src/rapidata/api_client/models/i_user_filter.py index 464ea7246b..1beec8b8dc 100644 --- a/src/rapidata/api_client/models/i_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_age_user_filter.py b/src/rapidata/api_client/models/i_user_filter_age_user_filter.py index 6fa37eca71..54a18b95f0 100644 --- a/src/rapidata/api_client/models/i_user_filter_age_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_age_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_and_user_filter.py b/src/rapidata/api_client/models/i_user_filter_and_user_filter.py index 10dd2c79ee..661ca3e459 100644 --- a/src/rapidata/api_client/models/i_user_filter_and_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_and_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_campaign_user_filter.py b/src/rapidata/api_client/models/i_user_filter_campaign_user_filter.py index a512d4b8c5..77a20dc30e 100644 --- a/src/rapidata/api_client/models/i_user_filter_campaign_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_campaign_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_country_user_filter.py b/src/rapidata/api_client/models/i_user_filter_country_user_filter.py index 062ca8c06b..365adb3525 100644 --- a/src/rapidata/api_client/models/i_user_filter_country_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_country_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_custom_user_filter.py b/src/rapidata/api_client/models/i_user_filter_custom_user_filter.py index 4f291d289f..ee8515b483 100644 --- a/src/rapidata/api_client/models/i_user_filter_custom_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_custom_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_device_user_filter.py b/src/rapidata/api_client/models/i_user_filter_device_user_filter.py index b2834a4941..abceaecb29 100644 --- a/src/rapidata/api_client/models/i_user_filter_device_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_device_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_gender_user_filter.py b/src/rapidata/api_client/models/i_user_filter_gender_user_filter.py index 2ac212b564..bbe864009e 100644 --- a/src/rapidata/api_client/models/i_user_filter_gender_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_gender_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_language_user_filter.py b/src/rapidata/api_client/models/i_user_filter_language_user_filter.py index d2c438b626..672b191c27 100644 --- a/src/rapidata/api_client/models/i_user_filter_language_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_language_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_new_user_filter.py b/src/rapidata/api_client/models/i_user_filter_new_user_filter.py index 9f1fe05ed1..4abbb7f841 100644 --- a/src/rapidata/api_client/models/i_user_filter_new_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_new_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_not_user_filter.py b/src/rapidata/api_client/models/i_user_filter_not_user_filter.py index 0c28ed8ea2..fb91d5e375 100644 --- a/src/rapidata/api_client/models/i_user_filter_not_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_not_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_or_user_filter.py b/src/rapidata/api_client/models/i_user_filter_or_user_filter.py index 53162abf58..b4ac0353e0 100644 --- a/src/rapidata/api_client/models/i_user_filter_or_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_or_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_response_count_user_filter.py b/src/rapidata/api_client/models/i_user_filter_response_count_user_filter.py index 7765c10d80..9b7755eba7 100644 --- a/src/rapidata/api_client/models/i_user_filter_response_count_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_response_count_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_user_filter_user_score_user_filter.py b/src/rapidata/api_client/models/i_user_filter_user_score_user_filter.py index 75488bd034..49963b0559 100644 --- a/src/rapidata/api_client/models/i_user_filter_user_score_user_filter.py +++ b/src/rapidata/api_client/models/i_user_filter_user_score_user_filter.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth.py b/src/rapidata/api_client/models/i_validation_truth.py index 8a90fd667e..58a32dc8b7 100644 --- a/src/rapidata/api_client/models/i_validation_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_attach_category_truth.py b/src/rapidata/api_client/models/i_validation_truth_attach_category_truth.py index d00c71dce2..16fae0a060 100644 --- a/src/rapidata/api_client/models/i_validation_truth_attach_category_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_attach_category_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_bounding_box_truth.py b/src/rapidata/api_client/models/i_validation_truth_bounding_box_truth.py index 0e1617d996..d2e011ef36 100644 --- a/src/rapidata/api_client/models/i_validation_truth_bounding_box_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_bounding_box_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_classify_truth.py b/src/rapidata/api_client/models/i_validation_truth_classify_truth.py index 6f57c63e0f..3d0f4acb19 100644 --- a/src/rapidata/api_client/models/i_validation_truth_classify_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_classify_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_compare_truth.py b/src/rapidata/api_client/models/i_validation_truth_compare_truth.py index f99f6646db..edbca38813 100644 --- a/src/rapidata/api_client/models/i_validation_truth_compare_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_compare_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_empty_validation_truth.py b/src/rapidata/api_client/models/i_validation_truth_empty_validation_truth.py index a6ceb0b34f..b84467e33c 100644 --- a/src/rapidata/api_client/models/i_validation_truth_empty_validation_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_empty_validation_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_line_truth.py b/src/rapidata/api_client/models/i_validation_truth_line_truth.py index e805f47aab..23b0846356 100644 --- a/src/rapidata/api_client/models/i_validation_truth_line_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_line_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_locate_box_truth.py b/src/rapidata/api_client/models/i_validation_truth_locate_box_truth.py index 1e20abcd6b..bcef3dcb95 100644 --- a/src/rapidata/api_client/models/i_validation_truth_locate_box_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_locate_box_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_multi_compare_truth.py b/src/rapidata/api_client/models/i_validation_truth_multi_compare_truth.py index ff2d984757..7902ebfefe 100644 --- a/src/rapidata/api_client/models/i_validation_truth_multi_compare_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_multi_compare_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_named_entity_truth.py b/src/rapidata/api_client/models/i_validation_truth_named_entity_truth.py index e1958f1200..cdcee32d86 100644 --- a/src/rapidata/api_client/models/i_validation_truth_named_entity_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_named_entity_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_polygon_truth.py b/src/rapidata/api_client/models/i_validation_truth_polygon_truth.py index 8d5b2a7dc3..e4affedb92 100644 --- a/src/rapidata/api_client/models/i_validation_truth_polygon_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_polygon_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_scrub_truth.py b/src/rapidata/api_client/models/i_validation_truth_scrub_truth.py index b9074bba80..0d8f18fc98 100644 --- a/src/rapidata/api_client/models/i_validation_truth_scrub_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_scrub_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_skip_truth.py b/src/rapidata/api_client/models/i_validation_truth_skip_truth.py index 62fb0303c7..17ed72d001 100644 --- a/src/rapidata/api_client/models/i_validation_truth_skip_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_skip_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_validation_truth_transcription_truth.py b/src/rapidata/api_client/models/i_validation_truth_transcription_truth.py index 2c43dd58c7..37d09b11a8 100644 --- a/src/rapidata/api_client/models/i_validation_truth_transcription_truth.py +++ b/src/rapidata/api_client/models/i_validation_truth_transcription_truth.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/i_workflow.py b/src/rapidata/api_client/models/i_workflow.py deleted file mode 100644 index 6f5e2b8743..0000000000 --- a/src/rapidata/api_client/models/i_workflow.py +++ /dev/null @@ -1,165 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -from __future__ import annotations -import json -import pprint -from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator -from typing import Any, List, Optional -from rapidata.api_client.models.i_workflow_evaluation_workflow import IWorkflowEvaluationWorkflow -from rapidata.api_client.models.i_workflow_grouped_ranking_workflow import IWorkflowGroupedRankingWorkflow -from rapidata.api_client.models.i_workflow_ranking_workflow import IWorkflowRankingWorkflow -from rapidata.api_client.models.i_workflow_simple_workflow import IWorkflowSimpleWorkflow -from pydantic import StrictStr, Field -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Union, List, Set, Optional, Dict -from typing_extensions import Literal, Self - -IWORKFLOW_ONE_OF_SCHEMAS = ["IWorkflowEvaluationWorkflow", "IWorkflowGroupedRankingWorkflow", "IWorkflowRankingWorkflow", "IWorkflowSimpleWorkflow"] - -class IWorkflow(LazyValidatedModel): - """ - IWorkflow - """ - # data type: IWorkflowEvaluationWorkflow - oneof_schema_1_validator: Optional[IWorkflowEvaluationWorkflow] = None - # data type: IWorkflowGroupedRankingWorkflow - oneof_schema_2_validator: Optional[IWorkflowGroupedRankingWorkflow] = None - # data type: IWorkflowRankingWorkflow - oneof_schema_3_validator: Optional[IWorkflowRankingWorkflow] = None - # data type: IWorkflowSimpleWorkflow - oneof_schema_4_validator: Optional[IWorkflowSimpleWorkflow] = None - actual_instance: Optional[Union[IWorkflowEvaluationWorkflow, IWorkflowGroupedRankingWorkflow, IWorkflowRankingWorkflow, IWorkflowSimpleWorkflow]] = None - one_of_schemas: Set[str] = { "IWorkflowEvaluationWorkflow", "IWorkflowGroupedRankingWorkflow", "IWorkflowRankingWorkflow", "IWorkflowSimpleWorkflow" } - - # model_config is inherited from LazyValidatedModel - - - discriminator_value_class_map: Dict[str, str] = { - } - - def __init__(self, *args, **kwargs) -> None: - if args: - if len(args) > 1: - raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") - if kwargs: - raise ValueError("If a position argument is used, keyword arguments cannot be used.") - super().__init__(actual_instance=args[0]) - else: - super().__init__(**kwargs) - - @field_validator('actual_instance') - def actual_instance_must_validate_oneof(cls, v): - instance = IWorkflow.model_construct() - error_messages = [] - match = 0 - # validate data type: IWorkflowEvaluationWorkflow - if not isinstance(v, IWorkflowEvaluationWorkflow): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowEvaluationWorkflow`") - else: - match += 1 - # validate data type: IWorkflowGroupedRankingWorkflow - if not isinstance(v, IWorkflowGroupedRankingWorkflow): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowGroupedRankingWorkflow`") - else: - match += 1 - # validate data type: IWorkflowRankingWorkflow - if not isinstance(v, IWorkflowRankingWorkflow): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRankingWorkflow`") - else: - match += 1 - # validate data type: IWorkflowSimpleWorkflow - if not isinstance(v, IWorkflowSimpleWorkflow): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowSimpleWorkflow`") - else: - match += 1 - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in IWorkflow with oneOf schemas: IWorkflowEvaluationWorkflow, IWorkflowGroupedRankingWorkflow, IWorkflowRankingWorkflow, IWorkflowSimpleWorkflow. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when setting `actual_instance` in IWorkflow with oneOf schemas: IWorkflowEvaluationWorkflow, IWorkflowGroupedRankingWorkflow, IWorkflowRankingWorkflow, IWorkflowSimpleWorkflow. Details: " + ", ".join(error_messages)) - else: - return v - - @classmethod - def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: - return cls.from_json(json.dumps(obj)) - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Returns the object represented by the json string""" - instance = cls.model_construct() - error_messages = [] - match = 0 - - # deserialize data into IWorkflowEvaluationWorkflow - try: - instance.actual_instance = IWorkflowEvaluationWorkflow.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowGroupedRankingWorkflow - try: - instance.actual_instance = IWorkflowGroupedRankingWorkflow.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRankingWorkflow - try: - instance.actual_instance = IWorkflowRankingWorkflow.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowSimpleWorkflow - try: - instance.actual_instance = IWorkflowSimpleWorkflow.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into IWorkflow with oneOf schemas: IWorkflowEvaluationWorkflow, IWorkflowGroupedRankingWorkflow, IWorkflowRankingWorkflow, IWorkflowSimpleWorkflow. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when deserializing the JSON string into IWorkflow with oneOf schemas: IWorkflowEvaluationWorkflow, IWorkflowGroupedRankingWorkflow, IWorkflowRankingWorkflow, IWorkflowSimpleWorkflow. Details: " + ", ".join(error_messages)) - else: - return instance - - def to_json(self) -> str: - """Returns the JSON representation of the actual instance""" - if self.actual_instance is None: - return "null" - - if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): - return self.actual_instance.to_json() - else: - return json.dumps(self.actual_instance) - - def to_dict(self) -> Optional[Union[Dict[str, Any], IWorkflowEvaluationWorkflow, IWorkflowGroupedRankingWorkflow, IWorkflowRankingWorkflow, IWorkflowSimpleWorkflow]]: - """Returns the dict representation of the actual instance""" - if self.actual_instance is None: - return None - - if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): - return self.actual_instance.to_dict() - else: - # primitive type - return self.actual_instance - - def to_str(self) -> str: - """Returns the string representation of the actual instance""" - return pprint.pformat(self.model_dump()) - - diff --git a/src/rapidata/api_client/models/i_workflow_config.py b/src/rapidata/api_client/models/i_workflow_config.py deleted file mode 100644 index f56771f7c3..0000000000 --- a/src/rapidata/api_client/models/i_workflow_config.py +++ /dev/null @@ -1,165 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -from __future__ import annotations -import json -import pprint -from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator -from typing import Any, List, Optional -from rapidata.api_client.models.i_workflow_config_evaluation_workflow_config import IWorkflowConfigEvaluationWorkflowConfig -from rapidata.api_client.models.i_workflow_config_grouped_ranking_workflow_config import IWorkflowConfigGroupedRankingWorkflowConfig -from rapidata.api_client.models.i_workflow_config_ranking_workflow_config import IWorkflowConfigRankingWorkflowConfig -from rapidata.api_client.models.i_workflow_config_simple_workflow_config import IWorkflowConfigSimpleWorkflowConfig -from pydantic import StrictStr, Field -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Union, List, Set, Optional, Dict -from typing_extensions import Literal, Self - -IWORKFLOWCONFIG_ONE_OF_SCHEMAS = ["IWorkflowConfigEvaluationWorkflowConfig", "IWorkflowConfigGroupedRankingWorkflowConfig", "IWorkflowConfigRankingWorkflowConfig", "IWorkflowConfigSimpleWorkflowConfig"] - -class IWorkflowConfig(LazyValidatedModel): - """ - IWorkflowConfig - """ - # data type: IWorkflowConfigEvaluationWorkflowConfig - oneof_schema_1_validator: Optional[IWorkflowConfigEvaluationWorkflowConfig] = None - # data type: IWorkflowConfigGroupedRankingWorkflowConfig - oneof_schema_2_validator: Optional[IWorkflowConfigGroupedRankingWorkflowConfig] = None - # data type: IWorkflowConfigRankingWorkflowConfig - oneof_schema_3_validator: Optional[IWorkflowConfigRankingWorkflowConfig] = None - # data type: IWorkflowConfigSimpleWorkflowConfig - oneof_schema_4_validator: Optional[IWorkflowConfigSimpleWorkflowConfig] = None - actual_instance: Optional[Union[IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig]] = None - one_of_schemas: Set[str] = { "IWorkflowConfigEvaluationWorkflowConfig", "IWorkflowConfigGroupedRankingWorkflowConfig", "IWorkflowConfigRankingWorkflowConfig", "IWorkflowConfigSimpleWorkflowConfig" } - - # model_config is inherited from LazyValidatedModel - - - discriminator_value_class_map: Dict[str, str] = { - } - - def __init__(self, *args, **kwargs) -> None: - if args: - if len(args) > 1: - raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") - if kwargs: - raise ValueError("If a position argument is used, keyword arguments cannot be used.") - super().__init__(actual_instance=args[0]) - else: - super().__init__(**kwargs) - - @field_validator('actual_instance') - def actual_instance_must_validate_oneof(cls, v): - instance = IWorkflowConfig.model_construct() - error_messages = [] - match = 0 - # validate data type: IWorkflowConfigEvaluationWorkflowConfig - if not isinstance(v, IWorkflowConfigEvaluationWorkflowConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowConfigEvaluationWorkflowConfig`") - else: - match += 1 - # validate data type: IWorkflowConfigGroupedRankingWorkflowConfig - if not isinstance(v, IWorkflowConfigGroupedRankingWorkflowConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowConfigGroupedRankingWorkflowConfig`") - else: - match += 1 - # validate data type: IWorkflowConfigRankingWorkflowConfig - if not isinstance(v, IWorkflowConfigRankingWorkflowConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowConfigRankingWorkflowConfig`") - else: - match += 1 - # validate data type: IWorkflowConfigSimpleWorkflowConfig - if not isinstance(v, IWorkflowConfigSimpleWorkflowConfig): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowConfigSimpleWorkflowConfig`") - else: - match += 1 - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in IWorkflowConfig with oneOf schemas: IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when setting `actual_instance` in IWorkflowConfig with oneOf schemas: IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig. Details: " + ", ".join(error_messages)) - else: - return v - - @classmethod - def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: - return cls.from_json(json.dumps(obj)) - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Returns the object represented by the json string""" - instance = cls.model_construct() - error_messages = [] - match = 0 - - # deserialize data into IWorkflowConfigEvaluationWorkflowConfig - try: - instance.actual_instance = IWorkflowConfigEvaluationWorkflowConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowConfigGroupedRankingWorkflowConfig - try: - instance.actual_instance = IWorkflowConfigGroupedRankingWorkflowConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowConfigRankingWorkflowConfig - try: - instance.actual_instance = IWorkflowConfigRankingWorkflowConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowConfigSimpleWorkflowConfig - try: - instance.actual_instance = IWorkflowConfigSimpleWorkflowConfig.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into IWorkflowConfig with oneOf schemas: IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when deserializing the JSON string into IWorkflowConfig with oneOf schemas: IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig. Details: " + ", ".join(error_messages)) - else: - return instance - - def to_json(self) -> str: - """Returns the JSON representation of the actual instance""" - if self.actual_instance is None: - return "null" - - if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): - return self.actual_instance.to_json() - else: - return json.dumps(self.actual_instance) - - def to_dict(self) -> Optional[Union[Dict[str, Any], IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig]]: - """Returns the dict representation of the actual instance""" - if self.actual_instance is None: - return None - - if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): - return self.actual_instance.to_dict() - else: - # primitive type - return self.actual_instance - - def to_str(self) -> str: - """Returns the string representation of the actual instance""" - return pprint.pformat(self.model_dump()) - - diff --git a/src/rapidata/api_client/models/i_workflow_config_evaluation_workflow_config.py b/src/rapidata/api_client/models/i_workflow_config_evaluation_workflow_config.py deleted file mode 100644 index 7de25dd314..0000000000 --- a/src/rapidata/api_client/models/i_workflow_config_evaluation_workflow_config.py +++ /dev/null @@ -1,120 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, field_validator -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.feature_flag import FeatureFlag -from rapidata.api_client.models.i_referee_config import IRefereeConfig -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowConfigEvaluationWorkflowConfig(LazyValidatedModel): - """ - IWorkflowConfigEvaluationWorkflowConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - validation_set_id: StrictStr = Field(alias="validationSetId") - referee: IRefereeConfig - should_accept_incorrect: StrictBool = Field(alias="shouldAcceptIncorrect") - feature_flags: Optional[List[FeatureFlag]] = Field(default=None, alias="featureFlags") - __properties: ClassVar[List[str]] = ["_t", "validationSetId", "referee", "shouldAcceptIncorrect", "featureFlags"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['EvaluationWorkflowConfig']): - raise ValueError("must be one of enum values ('EvaluationWorkflowConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowConfigEvaluationWorkflowConfig 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 referee - if self.referee: - _dict['referee'] = self.referee.to_dict() - # override the default output from pydantic by calling `to_dict()` of each item in feature_flags (list) - _items = [] - if self.feature_flags: - for _item_feature_flags in self.feature_flags: - if _item_feature_flags: - _items.append(_item_feature_flags.to_dict()) - _dict['featureFlags'] = _items - # set to None if feature_flags (nullable) is None - # and model_fields_set contains the field - if self.feature_flags is None and "feature_flags" in self.model_fields_set: - _dict['featureFlags'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowConfigEvaluationWorkflowConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "validationSetId": obj.get("validationSetId"), - "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None, - "shouldAcceptIncorrect": obj.get("shouldAcceptIncorrect"), - "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_config_grouped_ranking_workflow_config.py b/src/rapidata/api_client/models/i_workflow_config_grouped_ranking_workflow_config.py deleted file mode 100644 index 969840339e..0000000000 --- a/src/rapidata/api_client/models/i_workflow_config_grouped_ranking_workflow_config.py +++ /dev/null @@ -1,139 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.feature_flag import FeatureFlag -from rapidata.api_client.models.i_pipeline_pair_maker_config import IPipelinePairMakerConfig -from rapidata.api_client.models.i_pipeline_ranking_config import IPipelineRankingConfig -from rapidata.api_client.models.i_referee_config import IRefereeConfig -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowConfigGroupedRankingWorkflowConfig(LazyValidatedModel): - """ - IWorkflowConfigGroupedRankingWorkflowConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - criteria: StrictStr - referee: IRefereeConfig - target_country_codes: List[StrictStr] = Field(alias="targetCountryCodes") - max_parallelism: StrictInt = Field(alias="maxParallelism") - ranking_config: Optional[IPipelineRankingConfig] = Field(default=None, alias="rankingConfig") - pair_maker_config: IPipelinePairMakerConfig = Field(alias="pairMakerConfig") - feature_flags: Optional[List[FeatureFlag]] = Field(default=None, alias="featureFlags") - __properties: ClassVar[List[str]] = ["_t", "criteria", "referee", "targetCountryCodes", "maxParallelism", "rankingConfig", "pairMakerConfig", "featureFlags"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['GroupedRankingWorkflowConfig']): - raise ValueError("must be one of enum values ('GroupedRankingWorkflowConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowConfigGroupedRankingWorkflowConfig 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 referee - if self.referee: - _dict['referee'] = self.referee.to_dict() - # override the default output from pydantic by calling `to_dict()` of ranking_config - if self.ranking_config: - _dict['rankingConfig'] = self.ranking_config.to_dict() - # override the default output from pydantic by calling `to_dict()` of pair_maker_config - if self.pair_maker_config: - _dict['pairMakerConfig'] = self.pair_maker_config.to_dict() - # override the default output from pydantic by calling `to_dict()` of each item in feature_flags (list) - _items = [] - if self.feature_flags: - for _item_feature_flags in self.feature_flags: - if _item_feature_flags: - _items.append(_item_feature_flags.to_dict()) - _dict['featureFlags'] = _items - # set to None if ranking_config (nullable) is None - # and model_fields_set contains the field - if self.ranking_config is None and "ranking_config" in self.model_fields_set: - _dict['rankingConfig'] = None - - # set to None if feature_flags (nullable) is None - # and model_fields_set contains the field - if self.feature_flags is None and "feature_flags" in self.model_fields_set: - _dict['featureFlags'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowConfigGroupedRankingWorkflowConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "criteria": obj.get("criteria"), - "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None, - "targetCountryCodes": obj.get("targetCountryCodes"), - "maxParallelism": obj.get("maxParallelism"), - "rankingConfig": IPipelineRankingConfig.from_dict(obj["rankingConfig"]) if obj.get("rankingConfig") is not None else None, - "pairMakerConfig": IPipelinePairMakerConfig.from_dict(obj["pairMakerConfig"]) if obj.get("pairMakerConfig") is not None else None, - "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_config_ranking_workflow_config.py b/src/rapidata/api_client/models/i_workflow_config_ranking_workflow_config.py deleted file mode 100644 index 306890fe60..0000000000 --- a/src/rapidata/api_client/models/i_workflow_config_ranking_workflow_config.py +++ /dev/null @@ -1,153 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 rapidata.api_client.models.feature_flag import FeatureFlag -from rapidata.api_client.models.i_pipeline_asset import IPipelineAsset -from rapidata.api_client.models.i_pipeline_pair_maker_config import IPipelinePairMakerConfig -from rapidata.api_client.models.i_pipeline_ranking_config import IPipelineRankingConfig -from rapidata.api_client.models.i_referee_config import IRefereeConfig -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowConfigRankingWorkflowConfig(LazyValidatedModel): - """ - IWorkflowConfigRankingWorkflowConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - criteria: StrictStr - referee: IRefereeConfig - context: Optional[StrictStr] = None - context_asset: Optional[IPipelineAsset] = Field(default=None, alias="contextAsset") - ranking_config: Optional[IPipelineRankingConfig] = Field(default=None, alias="rankingConfig") - pair_maker_config: IPipelinePairMakerConfig = Field(alias="pairMakerConfig") - feature_flags: Optional[List[FeatureFlag]] = Field(default=None, alias="featureFlags") - __properties: ClassVar[List[str]] = ["_t", "criteria", "referee", "context", "contextAsset", "rankingConfig", "pairMakerConfig", "featureFlags"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['RankingWorkflowConfig']): - raise ValueError("must be one of enum values ('RankingWorkflowConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowConfigRankingWorkflowConfig 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 referee - if self.referee: - _dict['referee'] = self.referee.to_dict() - # override the default output from pydantic by calling `to_dict()` of context_asset - if self.context_asset: - _dict['contextAsset'] = self.context_asset.to_dict() - # override the default output from pydantic by calling `to_dict()` of ranking_config - if self.ranking_config: - _dict['rankingConfig'] = self.ranking_config.to_dict() - # override the default output from pydantic by calling `to_dict()` of pair_maker_config - if self.pair_maker_config: - _dict['pairMakerConfig'] = self.pair_maker_config.to_dict() - # override the default output from pydantic by calling `to_dict()` of each item in feature_flags (list) - _items = [] - if self.feature_flags: - for _item_feature_flags in self.feature_flags: - if _item_feature_flags: - _items.append(_item_feature_flags.to_dict()) - _dict['featureFlags'] = _items - # set to None if context (nullable) is None - # and model_fields_set contains the field - if self.context is None and "context" in self.model_fields_set: - _dict['context'] = None - - # set to None if context_asset (nullable) is None - # and model_fields_set contains the field - if self.context_asset is None and "context_asset" in self.model_fields_set: - _dict['contextAsset'] = None - - # set to None if ranking_config (nullable) is None - # and model_fields_set contains the field - if self.ranking_config is None and "ranking_config" in self.model_fields_set: - _dict['rankingConfig'] = None - - # set to None if feature_flags (nullable) is None - # and model_fields_set contains the field - if self.feature_flags is None and "feature_flags" in self.model_fields_set: - _dict['featureFlags'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowConfigRankingWorkflowConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "criteria": obj.get("criteria"), - "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None, - "context": obj.get("context"), - "contextAsset": IPipelineAsset.from_dict(obj["contextAsset"]) if obj.get("contextAsset") is not None else None, - "rankingConfig": IPipelineRankingConfig.from_dict(obj["rankingConfig"]) if obj.get("rankingConfig") is not None else None, - "pairMakerConfig": IPipelinePairMakerConfig.from_dict(obj["pairMakerConfig"]) if obj.get("pairMakerConfig") is not None else None, - "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_config_simple_workflow_config.py b/src/rapidata/api_client/models/i_workflow_config_simple_workflow_config.py deleted file mode 100644 index e2f2814a53..0000000000 --- a/src/rapidata/api_client/models/i_workflow_config_simple_workflow_config.py +++ /dev/null @@ -1,129 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.feature_flag import FeatureFlag -from rapidata.api_client.models.i_rapid_blueprint import IRapidBlueprint -from rapidata.api_client.models.i_referee_config import IRefereeConfig -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowConfigSimpleWorkflowConfig(LazyValidatedModel): - """ - IWorkflowConfigSimpleWorkflowConfig - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - referee: IRefereeConfig - blueprint: IRapidBlueprint - batch_size: Optional[StrictInt] = Field(default=None, alias="batchSize") - feature_flags: Optional[List[FeatureFlag]] = Field(default=None, alias="featureFlags") - __properties: ClassVar[List[str]] = ["_t", "referee", "blueprint", "batchSize", "featureFlags"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['SimpleWorkflowConfig']): - raise ValueError("must be one of enum values ('SimpleWorkflowConfig')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowConfigSimpleWorkflowConfig 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 referee - if self.referee: - _dict['referee'] = self.referee.to_dict() - # override the default output from pydantic by calling `to_dict()` of blueprint - if self.blueprint: - _dict['blueprint'] = self.blueprint.to_dict() - # override the default output from pydantic by calling `to_dict()` of each item in feature_flags (list) - _items = [] - if self.feature_flags: - for _item_feature_flags in self.feature_flags: - if _item_feature_flags: - _items.append(_item_feature_flags.to_dict()) - _dict['featureFlags'] = _items - # set to None if batch_size (nullable) is None - # and model_fields_set contains the field - if self.batch_size is None and "batch_size" in self.model_fields_set: - _dict['batchSize'] = None - - # set to None if feature_flags (nullable) is None - # and model_fields_set contains the field - if self.feature_flags is None and "feature_flags" in self.model_fields_set: - _dict['featureFlags'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowConfigSimpleWorkflowConfig from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None, - "blueprint": IRapidBlueprint.from_dict(obj["blueprint"]) if obj.get("blueprint") is not None else None, - "batchSize": obj.get("batchSize"), - "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_evaluation_workflow.py b/src/rapidata/api_client/models/i_workflow_evaluation_workflow.py deleted file mode 100644 index 77b4a9cc9e..0000000000 --- a/src/rapidata/api_client/models/i_workflow_evaluation_workflow.py +++ /dev/null @@ -1,119 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 rapidata.api_client.models.i_referee_config import IRefereeConfig -from rapidata.api_client.models.workflow_state import WorkflowState -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowEvaluationWorkflow(LazyValidatedModel): - """ - IWorkflowEvaluationWorkflow - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - id: StrictStr - validation_set_id: StrictStr = Field(alias="validationSetId") - state: WorkflowState - referee: IRefereeConfig - name: StrictStr - owner_mail: Optional[StrictStr] = Field(alias="ownerMail") - organization_id: StrictStr = Field(alias="organizationId") - __properties: ClassVar[List[str]] = ["_t", "id", "validationSetId", "state", "referee", "name", "ownerMail", "organizationId"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['EvaluationWorkflow']): - raise ValueError("must be one of enum values ('EvaluationWorkflow')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowEvaluationWorkflow 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 referee - if self.referee: - _dict['referee'] = self.referee.to_dict() - # set to None if owner_mail (nullable) is None - # and model_fields_set contains the field - if self.owner_mail is None and "owner_mail" in self.model_fields_set: - _dict['ownerMail'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowEvaluationWorkflow from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "id": obj.get("id"), - "validationSetId": obj.get("validationSetId"), - "state": obj.get("state"), - "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None, - "name": obj.get("name"), - "ownerMail": obj.get("ownerMail"), - "organizationId": obj.get("organizationId") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_grouped_ranking_workflow.py b/src/rapidata/api_client/models/i_workflow_grouped_ranking_workflow.py deleted file mode 100644 index 41fafef584..0000000000 --- a/src/rapidata/api_client/models/i_workflow_grouped_ranking_workflow.py +++ /dev/null @@ -1,130 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 rapidata.api_client.models.i_ranking_config import IRankingConfig -from rapidata.api_client.models.i_referee_config import IRefereeConfig -from rapidata.api_client.models.workflow_state import WorkflowState -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowGroupedRankingWorkflow(LazyValidatedModel): - """ - IWorkflowGroupedRankingWorkflow - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - id: StrictStr - referee: IRefereeConfig - state: WorkflowState - criteria: StrictStr - name: StrictStr - owner_mail: Optional[StrictStr] = Field(alias="ownerMail") - organization_id: StrictStr = Field(alias="organizationId") - ranking_config: Optional[IRankingConfig] = Field(default=None, alias="rankingConfig") - __properties: ClassVar[List[str]] = ["_t", "id", "referee", "state", "criteria", "name", "ownerMail", "organizationId", "rankingConfig"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['GroupedRankingWorkflowModel']): - raise ValueError("must be one of enum values ('GroupedRankingWorkflowModel')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowGroupedRankingWorkflow 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 referee - if self.referee: - _dict['referee'] = self.referee.to_dict() - # override the default output from pydantic by calling `to_dict()` of ranking_config - if self.ranking_config: - _dict['rankingConfig'] = self.ranking_config.to_dict() - # set to None if owner_mail (nullable) is None - # and model_fields_set contains the field - if self.owner_mail is None and "owner_mail" in self.model_fields_set: - _dict['ownerMail'] = None - - # set to None if ranking_config (nullable) is None - # and model_fields_set contains the field - if self.ranking_config is None and "ranking_config" in self.model_fields_set: - _dict['rankingConfig'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowGroupedRankingWorkflow from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "id": obj.get("id"), - "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None, - "state": obj.get("state"), - "criteria": obj.get("criteria"), - "name": obj.get("name"), - "ownerMail": obj.get("ownerMail"), - "organizationId": obj.get("organizationId"), - "rankingConfig": IRankingConfig.from_dict(obj["rankingConfig"]) if obj.get("rankingConfig") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_ranking_workflow.py b/src/rapidata/api_client/models/i_workflow_ranking_workflow.py deleted file mode 100644 index c07679838d..0000000000 --- a/src/rapidata/api_client/models/i_workflow_ranking_workflow.py +++ /dev/null @@ -1,154 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 rapidata.api_client.models.i_asset import IAsset -from rapidata.api_client.models.i_pair_maker_information import IPairMakerInformation -from rapidata.api_client.models.i_ranking_config import IRankingConfig -from rapidata.api_client.models.i_referee_config import IRefereeConfig -from rapidata.api_client.models.workflow_state import WorkflowState -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRankingWorkflow(LazyValidatedModel): - """ - IWorkflowRankingWorkflow - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - id: StrictStr - referee: IRefereeConfig - pair_maker_information: IPairMakerInformation = Field(alias="pairMakerInformation") - state: WorkflowState - criteria: StrictStr - name: StrictStr - ranking_config: Optional[IRankingConfig] = Field(default=None, alias="rankingConfig") - context: Optional[StrictStr] - context_asset: Optional[IAsset] = Field(alias="contextAsset") - owner_mail: Optional[StrictStr] = Field(alias="ownerMail") - organization_id: StrictStr = Field(alias="organizationId") - __properties: ClassVar[List[str]] = ["_t", "id", "referee", "pairMakerInformation", "state", "criteria", "name", "rankingConfig", "context", "contextAsset", "ownerMail", "organizationId"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['RankingWorkflowModel']): - raise ValueError("must be one of enum values ('RankingWorkflowModel')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRankingWorkflow 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 referee - if self.referee: - _dict['referee'] = self.referee.to_dict() - # override the default output from pydantic by calling `to_dict()` of pair_maker_information - if self.pair_maker_information: - _dict['pairMakerInformation'] = self.pair_maker_information.to_dict() - # override the default output from pydantic by calling `to_dict()` of ranking_config - if self.ranking_config: - _dict['rankingConfig'] = self.ranking_config.to_dict() - # override the default output from pydantic by calling `to_dict()` of context_asset - if self.context_asset: - _dict['contextAsset'] = self.context_asset.to_dict() - # set to None if ranking_config (nullable) is None - # and model_fields_set contains the field - if self.ranking_config is None and "ranking_config" in self.model_fields_set: - _dict['rankingConfig'] = None - - # set to None if context (nullable) is None - # and model_fields_set contains the field - if self.context is None and "context" in self.model_fields_set: - _dict['context'] = None - - # set to None if context_asset (nullable) is None - # and model_fields_set contains the field - if self.context_asset is None and "context_asset" in self.model_fields_set: - _dict['contextAsset'] = None - - # set to None if owner_mail (nullable) is None - # and model_fields_set contains the field - if self.owner_mail is None and "owner_mail" in self.model_fields_set: - _dict['ownerMail'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowRankingWorkflow from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "id": obj.get("id"), - "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None, - "pairMakerInformation": IPairMakerInformation.from_dict(obj["pairMakerInformation"]) if obj.get("pairMakerInformation") is not None else None, - "state": obj.get("state"), - "criteria": obj.get("criteria"), - "name": obj.get("name"), - "rankingConfig": IRankingConfig.from_dict(obj["rankingConfig"]) if obj.get("rankingConfig") is not None else None, - "context": obj.get("context"), - "contextAsset": IAsset.from_dict(obj["contextAsset"]) if obj.get("contextAsset") is not None else None, - "ownerMail": obj.get("ownerMail"), - "organizationId": obj.get("organizationId") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint.py deleted file mode 100644 index f959899784..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint.py +++ /dev/null @@ -1,249 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -from __future__ import annotations -import json -import pprint -from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator -from typing import Any, List, Optional -from rapidata.api_client.models.i_workflow_rapid_blueprint_attach_category_workflow_rapid_blueprint import IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint -from rapidata.api_client.models.i_workflow_rapid_blueprint_bounding_box_workflow_rapid_blueprint import IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint -from rapidata.api_client.models.i_workflow_rapid_blueprint_compare_workflow_rapid_blueprint import IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint -from rapidata.api_client.models.i_workflow_rapid_blueprint_free_text_workflow_rapid_blueprint import IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint -from rapidata.api_client.models.i_workflow_rapid_blueprint_line_workflow_rapid_blueprint import IWorkflowRapidBlueprintLineWorkflowRapidBlueprint -from rapidata.api_client.models.i_workflow_rapid_blueprint_locate_workflow_rapid_blueprint import IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint -from rapidata.api_client.models.i_workflow_rapid_blueprint_named_entity_workflow_rapid_blueprint import IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint -from rapidata.api_client.models.i_workflow_rapid_blueprint_polygon_workflow_rapid_blueprint import IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint -from rapidata.api_client.models.i_workflow_rapid_blueprint_scrub_workflow_rapid_blueprint import IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint -from rapidata.api_client.models.i_workflow_rapid_blueprint_transcription_workflow_rapid_blueprint import IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint -from pydantic import StrictStr, Field -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Union, List, Set, Optional, Dict -from typing_extensions import Literal, Self - -IWORKFLOWRAPIDBLUEPRINT_ONE_OF_SCHEMAS = ["IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint", "IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint", "IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint", "IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint", "IWorkflowRapidBlueprintLineWorkflowRapidBlueprint", "IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint", "IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint", "IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint", "IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint", "IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint"] - -class IWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprint - """ - # data type: IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint - oneof_schema_1_validator: Optional[IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint] = None - # data type: IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint - oneof_schema_2_validator: Optional[IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint] = None - # data type: IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint - oneof_schema_3_validator: Optional[IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint] = None - # data type: IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint - oneof_schema_4_validator: Optional[IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint] = None - # data type: IWorkflowRapidBlueprintLineWorkflowRapidBlueprint - oneof_schema_5_validator: Optional[IWorkflowRapidBlueprintLineWorkflowRapidBlueprint] = None - # data type: IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint - oneof_schema_6_validator: Optional[IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint] = None - # data type: IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint - oneof_schema_7_validator: Optional[IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint] = None - # data type: IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint - oneof_schema_8_validator: Optional[IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint] = None - # data type: IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint - oneof_schema_9_validator: Optional[IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint] = None - # data type: IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint - oneof_schema_10_validator: Optional[IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint] = None - actual_instance: Optional[Union[IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint, IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint, IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint, IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint, IWorkflowRapidBlueprintLineWorkflowRapidBlueprint, IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint, IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint, IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint, IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint, IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint]] = None - one_of_schemas: Set[str] = { "IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint", "IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint", "IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint", "IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint", "IWorkflowRapidBlueprintLineWorkflowRapidBlueprint", "IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint", "IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint", "IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint", "IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint", "IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint" } - - # model_config is inherited from LazyValidatedModel - - - discriminator_value_class_map: Dict[str, str] = { - } - - def __init__(self, *args, **kwargs) -> None: - if args: - if len(args) > 1: - raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") - if kwargs: - raise ValueError("If a position argument is used, keyword arguments cannot be used.") - super().__init__(actual_instance=args[0]) - else: - super().__init__(**kwargs) - - @field_validator('actual_instance') - def actual_instance_must_validate_oneof(cls, v): - instance = IWorkflowRapidBlueprint.model_construct() - error_messages = [] - match = 0 - # validate data type: IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint`") - else: - match += 1 - # validate data type: IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint`") - else: - match += 1 - # validate data type: IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint`") - else: - match += 1 - # validate data type: IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint`") - else: - match += 1 - # validate data type: IWorkflowRapidBlueprintLineWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintLineWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintLineWorkflowRapidBlueprint`") - else: - match += 1 - # validate data type: IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint`") - else: - match += 1 - # validate data type: IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint`") - else: - match += 1 - # validate data type: IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint`") - else: - match += 1 - # validate data type: IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint`") - else: - match += 1 - # validate data type: IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint - if not isinstance(v, IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint): - error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint`") - else: - match += 1 - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in IWorkflowRapidBlueprint with oneOf schemas: IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint, IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint, IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint, IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint, IWorkflowRapidBlueprintLineWorkflowRapidBlueprint, IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint, IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint, IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint, IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint, IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when setting `actual_instance` in IWorkflowRapidBlueprint with oneOf schemas: IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint, IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint, IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint, IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint, IWorkflowRapidBlueprintLineWorkflowRapidBlueprint, IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint, IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint, IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint, IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint, IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint. Details: " + ", ".join(error_messages)) - else: - return v - - @classmethod - def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: - return cls.from_json(json.dumps(obj)) - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Returns the object represented by the json string""" - instance = cls.model_construct() - error_messages = [] - match = 0 - - # deserialize data into IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRapidBlueprintLineWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintLineWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - # deserialize data into IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint - try: - instance.actual_instance = IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint.from_json(json_str) - match += 1 - except (ValidationError, ValueError) as e: - error_messages.append(str(e)) - - if match > 1: - # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into IWorkflowRapidBlueprint with oneOf schemas: IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint, IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint, IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint, IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint, IWorkflowRapidBlueprintLineWorkflowRapidBlueprint, IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint, IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint, IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint, IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint, IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint. Details: " + ", ".join(error_messages)) - elif match == 0: - # no match - raise ValueError("No match found when deserializing the JSON string into IWorkflowRapidBlueprint with oneOf schemas: IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint, IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint, IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint, IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint, IWorkflowRapidBlueprintLineWorkflowRapidBlueprint, IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint, IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint, IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint, IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint, IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint. Details: " + ", ".join(error_messages)) - else: - return instance - - def to_json(self) -> str: - """Returns the JSON representation of the actual instance""" - if self.actual_instance is None: - return "null" - - if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): - return self.actual_instance.to_json() - else: - return json.dumps(self.actual_instance) - - def to_dict(self) -> Optional[Union[Dict[str, Any], IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint, IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint, IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint, IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint, IWorkflowRapidBlueprintLineWorkflowRapidBlueprint, IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint, IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint, IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint, IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint, IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint]]: - """Returns the dict representation of the actual instance""" - if self.actual_instance is None: - return None - - if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): - return self.actual_instance.to_dict() - else: - # primitive type - return self.actual_instance - - def to_str(self) -> str: - """Returns the string representation of the actual instance""" - return pprint.pformat(self.model_dump()) - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_attach_category_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_attach_category_workflow_rapid_blueprint.py deleted file mode 100644 index 63c427930c..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_attach_category_workflow_rapid_blueprint.py +++ /dev/null @@ -1,107 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from rapidata.api_client.models.attach_category_workflow_rapid_blueprint_category import AttachCategoryWorkflowRapidBlueprintCategory -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - categories: List[AttachCategoryWorkflowRapidBlueprintCategory] - title: StrictStr - __properties: ClassVar[List[str]] = ["_t", "categories", "title"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['ClassifyBlueprint']): - raise ValueError("must be one of enum values ('ClassifyBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint 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 categories (list) - _items = [] - if self.categories: - for _item_categories in self.categories: - if _item_categories: - _items.append(_item_categories.to_dict()) - _dict['categories'] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "categories": [AttachCategoryWorkflowRapidBlueprintCategory.from_dict(_item) for _item in obj["categories"]] if obj.get("categories") is not None else None, - "title": obj.get("title") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_bounding_box_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_bounding_box_workflow_rapid_blueprint.py deleted file mode 100644 index 7b4b521fb1..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_bounding_box_workflow_rapid_blueprint.py +++ /dev/null @@ -1,97 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - target: StrictStr - __properties: ClassVar[List[str]] = ["_t", "target"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['BoundingBoxBlueprint']): - raise ValueError("must be one of enum values ('BoundingBoxBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint 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 IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "target": obj.get("target") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_compare_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_compare_workflow_rapid_blueprint.py deleted file mode 100644 index 73b004ec59..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_compare_workflow_rapid_blueprint.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - criteria: StrictStr - index_identifiers: List[StrictStr] = Field(alias="indexIdentifiers") - __properties: ClassVar[List[str]] = ["_t", "criteria", "indexIdentifiers"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['CompareBlueprint']): - raise ValueError("must be one of enum values ('CompareBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint 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 IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "criteria": obj.get("criteria"), - "indexIdentifiers": obj.get("indexIdentifiers") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_free_text_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_free_text_workflow_rapid_blueprint.py deleted file mode 100644 index 8a25c2d553..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_free_text_workflow_rapid_blueprint.py +++ /dev/null @@ -1,106 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, field_validator -from typing import Any, ClassVar, Dict, List, Optional -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - question: StrictStr - should_validate_response: StrictBool = Field(alias="shouldValidateResponse") - validation_system_prompt: Optional[StrictStr] = Field(default=None, alias="validationSystemPrompt") - __properties: ClassVar[List[str]] = ["_t", "question", "shouldValidateResponse", "validationSystemPrompt"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['FreeTextBlueprint']): - raise ValueError("must be one of enum values ('FreeTextBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint 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, - ) - # set to None if validation_system_prompt (nullable) is None - # and model_fields_set contains the field - if self.validation_system_prompt is None and "validation_system_prompt" in self.model_fields_set: - _dict['validationSystemPrompt'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "question": obj.get("question"), - "shouldValidateResponse": obj.get("shouldValidateResponse"), - "validationSystemPrompt": obj.get("validationSystemPrompt") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_line_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_line_workflow_rapid_blueprint.py deleted file mode 100644 index e4d7f2e9c1..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_line_workflow_rapid_blueprint.py +++ /dev/null @@ -1,97 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintLineWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintLineWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - target: StrictStr - __properties: ClassVar[List[str]] = ["_t", "target"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['LineBlueprint']): - raise ValueError("must be one of enum values ('LineBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintLineWorkflowRapidBlueprint 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 IWorkflowRapidBlueprintLineWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "target": obj.get("target") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_locate_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_locate_workflow_rapid_blueprint.py deleted file mode 100644 index 79546d31df..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_locate_workflow_rapid_blueprint.py +++ /dev/null @@ -1,97 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - target: StrictStr - __properties: ClassVar[List[str]] = ["_t", "target"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['LocateBlueprint']): - raise ValueError("must be one of enum values ('LocateBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint 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 IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "target": obj.get("target") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_named_entity_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_named_entity_workflow_rapid_blueprint.py deleted file mode 100644 index e39479d941..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_named_entity_workflow_rapid_blueprint.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - target: StrictStr - classes: List[StrictStr] - __properties: ClassVar[List[str]] = ["_t", "target", "classes"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['NamedEntityBlueprint']): - raise ValueError("must be one of enum values ('NamedEntityBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint 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 IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "target": obj.get("target"), - "classes": obj.get("classes") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_polygon_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_polygon_workflow_rapid_blueprint.py deleted file mode 100644 index 68ee85b9d8..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_polygon_workflow_rapid_blueprint.py +++ /dev/null @@ -1,97 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - target: StrictStr - __properties: ClassVar[List[str]] = ["_t", "target"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['PolygonBlueprint']): - raise ValueError("must be one of enum values ('PolygonBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint 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 IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "target": obj.get("target") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_scrub_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_scrub_workflow_rapid_blueprint.py deleted file mode 100644 index 4f2a2c37f5..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_scrub_workflow_rapid_blueprint.py +++ /dev/null @@ -1,97 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - target: StrictStr - __properties: ClassVar[List[str]] = ["_t", "target"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['ScrubBlueprint']): - raise ValueError("must be one of enum values ('ScrubBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint 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 IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "target": obj.get("target") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_transcription_workflow_rapid_blueprint.py b/src/rapidata/api_client/models/i_workflow_rapid_blueprint_transcription_workflow_rapid_blueprint.py deleted file mode 100644 index a6c118fb26..0000000000 --- a/src/rapidata/api_client/models/i_workflow_rapid_blueprint_transcription_workflow_rapid_blueprint.py +++ /dev/null @@ -1,97 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint(LazyValidatedModel): - """ - IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - title: StrictStr - __properties: ClassVar[List[str]] = ["_t", "title"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['TranscriptionBlueprint']): - raise ValueError("must be one of enum values ('TranscriptionBlueprint')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint 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 IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "title": obj.get("title") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/i_workflow_simple_workflow.py b/src/rapidata/api_client/models/i_workflow_simple_workflow.py deleted file mode 100644 index c3392abee5..0000000000 --- a/src/rapidata/api_client/models/i_workflow_simple_workflow.py +++ /dev/null @@ -1,123 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 rapidata.api_client.models.i_referee_config import IRefereeConfig -from rapidata.api_client.models.i_workflow_rapid_blueprint import IWorkflowRapidBlueprint -from rapidata.api_client.models.workflow_state import WorkflowState -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class IWorkflowSimpleWorkflow(LazyValidatedModel): - """ - IWorkflowSimpleWorkflow - """ # noqa: E501 - t: StrictStr = Field(alias="_t") - id: StrictStr - state: WorkflowState - blueprint: IWorkflowRapidBlueprint - referee: IRefereeConfig - name: StrictStr - owner_mail: Optional[StrictStr] = Field(alias="ownerMail") - organization_id: StrictStr = Field(alias="organizationId") - __properties: ClassVar[List[str]] = ["_t", "id", "state", "blueprint", "referee", "name", "ownerMail", "organizationId"] - - @field_validator('t') - def t_validate_enum(cls, value): - """Validates the enum""" - if value not in set(['SimpleWorkflowModel']): - raise ValueError("must be one of enum values ('SimpleWorkflowModel')") - return value - - # model_config is inherited from LazyValidatedModel - - - 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 IWorkflowSimpleWorkflow 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 blueprint - if self.blueprint: - _dict['blueprint'] = self.blueprint.to_dict() - # override the default output from pydantic by calling `to_dict()` of referee - if self.referee: - _dict['referee'] = self.referee.to_dict() - # set to None if owner_mail (nullable) is None - # and model_fields_set contains the field - if self.owner_mail is None and "owner_mail" in self.model_fields_set: - _dict['ownerMail'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IWorkflowSimpleWorkflow from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "_t": obj.get("_t"), - "id": obj.get("id"), - "state": obj.get("state"), - "blueprint": IWorkflowRapidBlueprint.from_dict(obj["blueprint"]) if obj.get("blueprint") is not None else None, - "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None, - "name": obj.get("name"), - "ownerMail": obj.get("ownerMail"), - "organizationId": obj.get("organizationId") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/inspect_report_endpoint_output.py b/src/rapidata/api_client/models/inspect_report_endpoint_output.py index e2e82c7c73..e4f357aef9 100644 --- a/src/rapidata/api_client/models/inspect_report_endpoint_output.py +++ b/src/rapidata/api_client/models/inspect_report_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/invite_org_member_endpoint_input.py b/src/rapidata/api_client/models/invite_org_member_endpoint_input.py index c3fc9237f6..9d69151352 100644 --- a/src/rapidata/api_client/models/invite_org_member_endpoint_input.py +++ b/src/rapidata/api_client/models/invite_org_member_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/invite_org_member_endpoint_output.py b/src/rapidata/api_client/models/invite_org_member_endpoint_output.py index 0c1a150c01..5ad800e13c 100644 --- a/src/rapidata/api_client/models/invite_org_member_endpoint_output.py +++ b/src/rapidata/api_client/models/invite_org_member_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/invoice_status.py b/src/rapidata/api_client/models/invoice_status.py index fd65aa5bad..2c82f9b66a 100644 --- a/src/rapidata/api_client/models/invoice_status.py +++ b/src/rapidata/api_client/models/invoice_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/is_rapid_bag_valid_endpoint_output.py b/src/rapidata/api_client/models/is_rapid_bag_valid_endpoint_output.py index 94371dddad..ba2493fc1d 100644 --- a/src/rapidata/api_client/models/is_rapid_bag_valid_endpoint_output.py +++ b/src/rapidata/api_client/models/is_rapid_bag_valid_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/job_definition_revision_state.py b/src/rapidata/api_client/models/job_definition_revision_state.py index 0f22626c93..ae2439baaa 100644 --- a/src/rapidata/api_client/models/job_definition_revision_state.py +++ b/src/rapidata/api_client/models/job_definition_revision_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/job_navigation_item.py b/src/rapidata/api_client/models/job_navigation_item.py index 08fa9a67c9..ab8ee6a96b 100644 --- a/src/rapidata/api_client/models/job_navigation_item.py +++ b/src/rapidata/api_client/models/job_navigation_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/job_rapid_result.py b/src/rapidata/api_client/models/job_rapid_result.py index b04eab6fb5..c82a545d3a 100644 --- a/src/rapidata/api_client/models/job_rapid_result.py +++ b/src/rapidata/api_client/models/job_rapid_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/job_response.py b/src/rapidata/api_client/models/job_response.py index 7399a9a19b..9a39327400 100644 --- a/src/rapidata/api_client/models/job_response.py +++ b/src/rapidata/api_client/models/job_response.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/json_web_key.py b/src/rapidata/api_client/models/json_web_key.py index 57fece3e41..b72acc1053 100644 --- a/src/rapidata/api_client/models/json_web_key.py +++ b/src/rapidata/api_client/models/json_web_key.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/json_web_key_set.py b/src/rapidata/api_client/models/json_web_key_set.py index b6825bea39..b2096d355b 100644 --- a/src/rapidata/api_client/models/json_web_key_set.py +++ b/src/rapidata/api_client/models/json_web_key_set.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/labeling_state.py b/src/rapidata/api_client/models/labeling_state.py index 41c2e60aa4..2b56e4505d 100644 --- a/src/rapidata/api_client/models/labeling_state.py +++ b/src/rapidata/api_client/models/labeling_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/line_result_line.py b/src/rapidata/api_client/models/line_result_line.py index c5aad12901..0fea08e033 100644 --- a/src/rapidata/api_client/models/line_result_line.py +++ b/src/rapidata/api_client/models/line_result_line.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/line_result_line_point.py b/src/rapidata/api_client/models/line_result_line_point.py index 16bc28077e..ac71517320 100644 --- a/src/rapidata/api_client/models/line_result_line_point.py +++ b/src/rapidata/api_client/models/line_result_line_point.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/list_org_invitations_endpoint_output.py b/src/rapidata/api_client/models/list_org_invitations_endpoint_output.py index 74f0a9e618..45e16257df 100644 --- a/src/rapidata/api_client/models/list_org_invitations_endpoint_output.py +++ b/src/rapidata/api_client/models/list_org_invitations_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/list_org_invitations_endpoint_output_invitation.py b/src/rapidata/api_client/models/list_org_invitations_endpoint_output_invitation.py index a65a182063..a837812136 100644 --- a/src/rapidata/api_client/models/list_org_invitations_endpoint_output_invitation.py +++ b/src/rapidata/api_client/models/list_org_invitations_endpoint_output_invitation.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/list_org_members_endpoint_output.py b/src/rapidata/api_client/models/list_org_members_endpoint_output.py index 7d4c94e828..733b833f81 100644 --- a/src/rapidata/api_client/models/list_org_members_endpoint_output.py +++ b/src/rapidata/api_client/models/list_org_members_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/list_org_members_endpoint_output_member.py b/src/rapidata/api_client/models/list_org_members_endpoint_output_member.py index b58fc86820..a1a1eb9fbb 100644 --- a/src/rapidata/api_client/models/list_org_members_endpoint_output_member.py +++ b/src/rapidata/api_client/models/list_org_members_endpoint_output_member.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/locate_box_truth_box.py b/src/rapidata/api_client/models/locate_box_truth_box.py index 1e63df24b7..a7efb50968 100644 --- a/src/rapidata/api_client/models/locate_box_truth_box.py +++ b/src/rapidata/api_client/models/locate_box_truth_box.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/locate_coordinate.py b/src/rapidata/api_client/models/locate_coordinate.py index 2bc2268490..ba9f96a768 100644 --- a/src/rapidata/api_client/models/locate_coordinate.py +++ b/src/rapidata/api_client/models/locate_coordinate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/logic_operator.py b/src/rapidata/api_client/models/logic_operator.py deleted file mode 100644 index de34ad5d98..0000000000 --- a/src/rapidata/api_client/models/logic_operator.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -from __future__ import annotations -import json -from enum import Enum -from typing_extensions import Self - - -class LogicOperator(str, Enum): - """ - LogicOperator - """ - - """ - allowed enum values - """ - AND = 'And' - OR = 'Or' - NOT = 'Not' - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Create an instance of LogicOperator from a JSON string""" - return cls(json.loads(json_str)) - - diff --git a/src/rapidata/api_client/models/manual_charge_reason.py b/src/rapidata/api_client/models/manual_charge_reason.py index ca11894cbf..ccacc0d77d 100644 --- a/src/rapidata/api_client/models/manual_charge_reason.py +++ b/src/rapidata/api_client/models/manual_charge_reason.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/matchup_zone.py b/src/rapidata/api_client/models/matchup_zone.py index 2443e01467..663a569819 100644 --- a/src/rapidata/api_client/models/matchup_zone.py +++ b/src/rapidata/api_client/models/matchup_zone.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/membership_status.py b/src/rapidata/api_client/models/membership_status.py index 9ba101296a..631d76165d 100644 --- a/src/rapidata/api_client/models/membership_status.py +++ b/src/rapidata/api_client/models/membership_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/model_license_type.py b/src/rapidata/api_client/models/model_license_type.py index b868ba3a7a..032fb00e2c 100644 --- a/src/rapidata/api_client/models/model_license_type.py +++ b/src/rapidata/api_client/models/model_license_type.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/named_entity_result_named_classification.py b/src/rapidata/api_client/models/named_entity_result_named_classification.py index ac74e48ab9..594636764c 100644 --- a/src/rapidata/api_client/models/named_entity_result_named_classification.py +++ b/src/rapidata/api_client/models/named_entity_result_named_classification.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/named_entity_truth_named_classification.py b/src/rapidata/api_client/models/named_entity_truth_named_classification.py index da3b5ca38f..e79a494c9e 100644 --- a/src/rapidata/api_client/models/named_entity_truth_named_classification.py +++ b/src/rapidata/api_client/models/named_entity_truth_named_classification.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/order_state.py b/src/rapidata/api_client/models/order_state.py index 17c486ef02..3278013f64 100644 --- a/src/rapidata/api_client/models/order_state.py +++ b/src/rapidata/api_client/models/order_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/org_role.py b/src/rapidata/api_client/models/org_role.py index 7d03bb910f..a30a301144 100644 --- a/src/rapidata/api_client/models/org_role.py +++ b/src/rapidata/api_client/models/org_role.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/origin.py b/src/rapidata/api_client/models/origin.py index e3dee9be40..ad7a2a3fee 100644 --- a/src/rapidata/api_client/models/origin.py +++ b/src/rapidata/api_client/models/origin.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/page_info.py b/src/rapidata/api_client/models/page_info.py deleted file mode 100644 index f7d91f1090..0000000000 --- a/src/rapidata/api_client/models/page_info.py +++ /dev/null @@ -1,89 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictInt -from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set -from typing_extensions import Self - -class PageInfo(BaseModel): - """ - PageInfo - """ # noqa: E501 - index: Optional[StrictInt] = None - size: Optional[StrictInt] = None - __properties: ClassVar[List[str]] = ["index", "size"] - - 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 PageInfo 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 PageInfo from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _obj = cls.model_validate({ - "index": obj.get("index"), - "size": obj.get("size") - }) - return _obj - - diff --git a/src/rapidata/api_client/models/paged_result_of_get_grouped_ranking_workflow_results_result.py b/src/rapidata/api_client/models/paged_result_of_get_grouped_ranking_workflow_results_result.py deleted file mode 100644 index 9f4d09ae81..0000000000 --- a/src/rapidata/api_client/models/paged_result_of_get_grouped_ranking_workflow_results_result.py +++ /dev/null @@ -1,105 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictInt -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.get_grouped_ranking_workflow_results_result import GetGroupedRankingWorkflowResultsResult -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class PagedResultOfGetGroupedRankingWorkflowResultsResult(LazyValidatedModel): - """ - PagedResultOfGetGroupedRankingWorkflowResultsResult - """ # noqa: E501 - total: StrictInt - page: StrictInt - page_size: StrictInt = Field(alias="pageSize") - items: List[GetGroupedRankingWorkflowResultsResult] - total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages") - __properties: ClassVar[List[str]] = ["total", "page", "pageSize", "items", "totalPages"] - - # model_config is inherited from LazyValidatedModel - - - 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 PagedResultOfGetGroupedRankingWorkflowResultsResult 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 items (list) - _items = [] - if self.items: - for _item_items in self.items: - if _item_items: - _items.append(_item_items.to_dict()) - _dict['items'] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of PagedResultOfGetGroupedRankingWorkflowResultsResult from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "total": obj.get("total"), - "page": obj.get("page"), - "pageSize": obj.get("pageSize"), - "items": [GetGroupedRankingWorkflowResultsResult.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, - "totalPages": obj.get("totalPages") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/paged_result_of_get_workflow_results_result.py b/src/rapidata/api_client/models/paged_result_of_get_workflow_results_result.py deleted file mode 100644 index 7298330905..0000000000 --- a/src/rapidata/api_client/models/paged_result_of_get_workflow_results_result.py +++ /dev/null @@ -1,105 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictInt -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.get_workflow_results_result import GetWorkflowResultsResult -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class PagedResultOfGetWorkflowResultsResult(LazyValidatedModel): - """ - PagedResultOfGetWorkflowResultsResult - """ # noqa: E501 - total: StrictInt - page: StrictInt - page_size: StrictInt = Field(alias="pageSize") - items: List[GetWorkflowResultsResult] - total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages") - __properties: ClassVar[List[str]] = ["total", "page", "pageSize", "items", "totalPages"] - - # model_config is inherited from LazyValidatedModel - - - 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 PagedResultOfGetWorkflowResultsResult 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 items (list) - _items = [] - if self.items: - for _item_items in self.items: - if _item_items: - _items.append(_item_items.to_dict()) - _dict['items'] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of PagedResultOfGetWorkflowResultsResult from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "total": obj.get("total"), - "page": obj.get("page"), - "pageSize": obj.get("pageSize"), - "items": [GetWorkflowResultsResult.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, - "totalPages": obj.get("totalPages") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/paged_result_of_i_billing_group.py b/src/rapidata/api_client/models/paged_result_of_i_billing_group.py index ffa7771141..7e00c413a6 100644 --- a/src/rapidata/api_client/models/paged_result_of_i_billing_group.py +++ b/src/rapidata/api_client/models/paged_result_of_i_billing_group.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/pagination.py b/src/rapidata/api_client/models/pagination.py deleted file mode 100644 index 18f8786f78..0000000000 --- a/src/rapidata/api_client/models/pagination.py +++ /dev/null @@ -1,91 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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, StrictInt -from typing import Any, ClassVar, Dict, List, Optional -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class Pagination(LazyValidatedModel): - """ - Pagination - """ # noqa: E501 - index: Optional[StrictInt] = None - size: Optional[StrictInt] = None - __properties: ClassVar[List[str]] = ["index", "size"] - - # model_config is inherited from LazyValidatedModel - - - 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 Pagination 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 Pagination from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "index": obj.get("index"), - "size": obj.get("size") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/participant_status.py b/src/rapidata/api_client/models/participant_status.py index a2a921a5cb..9ccb3d3535 100644 --- a/src/rapidata/api_client/models/participant_status.py +++ b/src/rapidata/api_client/models/participant_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/pid_batch_mode.py b/src/rapidata/api_client/models/pid_batch_mode.py index 1d51d76c70..0c9e8873dc 100644 --- a/src/rapidata/api_client/models/pid_batch_mode.py +++ b/src/rapidata/api_client/models/pid_batch_mode.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/polygon_result_coordinate.py b/src/rapidata/api_client/models/polygon_result_coordinate.py index 1d1e9b9645..9ddc294236 100644 --- a/src/rapidata/api_client/models/polygon_result_coordinate.py +++ b/src/rapidata/api_client/models/polygon_result_coordinate.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/polygon_result_shape.py b/src/rapidata/api_client/models/polygon_result_shape.py index 21ba2371c9..d6d1d4dba0 100644 --- a/src/rapidata/api_client/models/polygon_result_shape.py +++ b/src/rapidata/api_client/models/polygon_result_shape.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/preview_order_endpoint_input.py b/src/rapidata/api_client/models/preview_order_endpoint_input.py index 5523e836ec..9baff7d767 100644 --- a/src/rapidata/api_client/models/preview_order_endpoint_input.py +++ b/src/rapidata/api_client/models/preview_order_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/problem_details.py b/src/rapidata/api_client/models/problem_details.py index 4d01f6e501..fc0f9a08cf 100644 --- a/src/rapidata/api_client/models/problem_details.py +++ b/src/rapidata/api_client/models/problem_details.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/program_case.py b/src/rapidata/api_client/models/program_case.py index 436c17ffc1..b41d58878f 100644 --- a/src/rapidata/api_client/models/program_case.py +++ b/src/rapidata/api_client/models/program_case.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/program_comparison.py b/src/rapidata/api_client/models/program_comparison.py index 98c6a08e29..e6fdbfa8d6 100644 --- a/src/rapidata/api_client/models/program_comparison.py +++ b/src/rapidata/api_client/models/program_comparison.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/prompt_embedding_map_status.py b/src/rapidata/api_client/models/prompt_embedding_map_status.py index bd0dce613f..09e026fc65 100644 --- a/src/rapidata/api_client/models/prompt_embedding_map_status.py +++ b/src/rapidata/api_client/models/prompt_embedding_map_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_aggregated_jobs_endpoint_output.py b/src/rapidata/api_client/models/query_aggregated_jobs_endpoint_output.py index 36097280db..35a339a5f6 100644 --- a/src/rapidata/api_client/models/query_aggregated_jobs_endpoint_output.py +++ b/src/rapidata/api_client/models/query_aggregated_jobs_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_aggregated_jobs_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_aggregated_jobs_endpoint_paged_result_of_output.py index acb18b1589..f162dc325d 100644 --- a/src/rapidata/api_client/models/query_aggregated_jobs_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_aggregated_jobs_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_aggregated_orders_endpoint_output.py b/src/rapidata/api_client/models/query_aggregated_orders_endpoint_output.py index 275c98c12a..83ed0d361e 100644 --- a/src/rapidata/api_client/models/query_aggregated_orders_endpoint_output.py +++ b/src/rapidata/api_client/models/query_aggregated_orders_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_aggregated_orders_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_aggregated_orders_endpoint_paged_result_of_output.py index 5cd4eff96e..b292b98874 100644 --- a/src/rapidata/api_client/models/query_aggregated_orders_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_aggregated_orders_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_all_organizations_endpoint_output.py b/src/rapidata/api_client/models/query_all_organizations_endpoint_output.py index 10602bb2de..a72d404968 100644 --- a/src/rapidata/api_client/models/query_all_organizations_endpoint_output.py +++ b/src/rapidata/api_client/models/query_all_organizations_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_all_organizations_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_all_organizations_endpoint_paged_result_of_output.py index 47764b941b..f756bcc924 100644 --- a/src/rapidata/api_client/models/query_all_organizations_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_all_organizations_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_audience_jobs_endpoint_output.py b/src/rapidata/api_client/models/query_audience_jobs_endpoint_output.py index e9a9c1d1e4..fae28f907f 100644 --- a/src/rapidata/api_client/models/query_audience_jobs_endpoint_output.py +++ b/src/rapidata/api_client/models/query_audience_jobs_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_audience_jobs_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_audience_jobs_endpoint_paged_result_of_output.py index aa384dc54e..b819c8f32f 100644 --- a/src/rapidata/api_client/models/query_audience_jobs_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_audience_jobs_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_audiences_endpoint_output.py b/src/rapidata/api_client/models/query_audiences_endpoint_output.py index b2fd81cfb7..f4fdc10ba0 100644 --- a/src/rapidata/api_client/models/query_audiences_endpoint_output.py +++ b/src/rapidata/api_client/models/query_audiences_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_audiences_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_audiences_endpoint_paged_result_of_output.py index de4c6035b4..f69b43a23b 100644 --- a/src/rapidata/api_client/models/query_audiences_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_audiences_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_benchmark_standings_endpoint_output.py b/src/rapidata/api_client/models/query_benchmark_standings_endpoint_output.py index 91cecb1874..bcda10f713 100644 --- a/src/rapidata/api_client/models/query_benchmark_standings_endpoint_output.py +++ b/src/rapidata/api_client/models/query_benchmark_standings_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_benchmark_standings_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_benchmark_standings_endpoint_paged_result_of_output.py index 10a9b3d23e..84746d6de7 100644 --- a/src/rapidata/api_client/models/query_benchmark_standings_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_benchmark_standings_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_benchmarks_endpoint_output.py b/src/rapidata/api_client/models/query_benchmarks_endpoint_output.py index f5ceac342e..b21c913a02 100644 --- a/src/rapidata/api_client/models/query_benchmarks_endpoint_output.py +++ b/src/rapidata/api_client/models/query_benchmarks_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_benchmarks_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_benchmarks_endpoint_paged_result_of_output.py index 2fcc703d92..fc176fa7cd 100644 --- a/src/rapidata/api_client/models/query_benchmarks_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_benchmarks_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_billing_periods_endpoint_output.py b/src/rapidata/api_client/models/query_billing_periods_endpoint_output.py index cbbdd8153a..bc92c821f0 100644 --- a/src/rapidata/api_client/models/query_billing_periods_endpoint_output.py +++ b/src/rapidata/api_client/models/query_billing_periods_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_billing_periods_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_billing_periods_endpoint_paged_result_of_output.py index cda13f5476..3373645d93 100644 --- a/src/rapidata/api_client/models/query_billing_periods_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_billing_periods_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_campaigns_endpoint_output.py b/src/rapidata/api_client/models/query_campaigns_endpoint_output.py index 1a46369d57..0c1bd2d4d5 100644 --- a/src/rapidata/api_client/models/query_campaigns_endpoint_output.py +++ b/src/rapidata/api_client/models/query_campaigns_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_campaigns_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_campaigns_endpoint_paged_result_of_output.py index eba86a47d2..ed6b449d66 100644 --- a/src/rapidata/api_client/models/query_campaigns_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_campaigns_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_clients_endpoint_output.py b/src/rapidata/api_client/models/query_clients_endpoint_output.py index 085c835cf0..f77a823d92 100644 --- a/src/rapidata/api_client/models/query_clients_endpoint_output.py +++ b/src/rapidata/api_client/models/query_clients_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_clients_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_clients_endpoint_paged_result_of_output.py index 93a2de9299..67151eaaee 100644 --- a/src/rapidata/api_client/models/query_clients_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_clients_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_combined_matrix_by_benchmarks_endpoint_output.py b/src/rapidata/api_client/models/query_combined_matrix_by_benchmarks_endpoint_output.py index 66b7de29a6..8b4787d57c 100644 --- a/src/rapidata/api_client/models/query_combined_matrix_by_benchmarks_endpoint_output.py +++ b/src/rapidata/api_client/models/query_combined_matrix_by_benchmarks_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_combined_matrix_by_leaderboards_endpoint_output.py b/src/rapidata/api_client/models/query_combined_matrix_by_leaderboards_endpoint_output.py index 2dea79911b..21d757080c 100644 --- a/src/rapidata/api_client/models/query_combined_matrix_by_leaderboards_endpoint_output.py +++ b/src/rapidata/api_client/models/query_combined_matrix_by_leaderboards_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_combined_standings_by_benchmarks_endpoint_output.py b/src/rapidata/api_client/models/query_combined_standings_by_benchmarks_endpoint_output.py index 11b6421524..95a7942db5 100644 --- a/src/rapidata/api_client/models/query_combined_standings_by_benchmarks_endpoint_output.py +++ b/src/rapidata/api_client/models/query_combined_standings_by_benchmarks_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_combined_standings_by_benchmarks_endpoint_output_item.py b/src/rapidata/api_client/models/query_combined_standings_by_benchmarks_endpoint_output_item.py index ac463b62fd..ba2bf92244 100644 --- a/src/rapidata/api_client/models/query_combined_standings_by_benchmarks_endpoint_output_item.py +++ b/src/rapidata/api_client/models/query_combined_standings_by_benchmarks_endpoint_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_combined_standings_by_leaderboards_endpoint_output.py b/src/rapidata/api_client/models/query_combined_standings_by_leaderboards_endpoint_output.py index 51bdd484e2..377d1bc86d 100644 --- a/src/rapidata/api_client/models/query_combined_standings_by_leaderboards_endpoint_output.py +++ b/src/rapidata/api_client/models/query_combined_standings_by_leaderboards_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_combined_standings_by_leaderboards_endpoint_output_item.py b/src/rapidata/api_client/models/query_combined_standings_by_leaderboards_endpoint_output_item.py index fbfb8fd602..c2626ef6d2 100644 --- a/src/rapidata/api_client/models/query_combined_standings_by_leaderboards_endpoint_output_item.py +++ b/src/rapidata/api_client/models/query_combined_standings_by_leaderboards_endpoint_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_costs_by_customer_endpoint_output.py b/src/rapidata/api_client/models/query_costs_by_customer_endpoint_output.py index 612c5a99ff..dbf750352e 100644 --- a/src/rapidata/api_client/models/query_costs_by_customer_endpoint_output.py +++ b/src/rapidata/api_client/models/query_costs_by_customer_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_costs_by_customer_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_costs_by_customer_endpoint_paged_result_of_output.py index 6b11173c93..5fbd8ed558 100644 --- a/src/rapidata/api_client/models/query_costs_by_customer_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_costs_by_customer_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_costs_by_organization_endpoint_output.py b/src/rapidata/api_client/models/query_costs_by_organization_endpoint_output.py index 7031ab74a2..c6ad70ca78 100644 --- a/src/rapidata/api_client/models/query_costs_by_organization_endpoint_output.py +++ b/src/rapidata/api_client/models/query_costs_by_organization_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_costs_by_organization_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_costs_by_organization_endpoint_paged_result_of_output.py index 10b23ce735..927eed0bc7 100644 --- a/src/rapidata/api_client/models/query_costs_by_organization_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_costs_by_organization_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_customers_endpoint_output.py b/src/rapidata/api_client/models/query_customers_endpoint_output.py index daf4599cf9..f5acda6e8d 100644 --- a/src/rapidata/api_client/models/query_customers_endpoint_output.py +++ b/src/rapidata/api_client/models/query_customers_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_customers_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_customers_endpoint_paged_result_of_output.py index 219663c28e..4fa720087d 100644 --- a/src/rapidata/api_client/models/query_customers_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_customers_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_datapoints_by_dataset_id_endpoint_output.py b/src/rapidata/api_client/models/query_datapoints_by_dataset_id_endpoint_output.py index 31317a4752..9cc059dd5f 100644 --- a/src/rapidata/api_client/models/query_datapoints_by_dataset_id_endpoint_output.py +++ b/src/rapidata/api_client/models/query_datapoints_by_dataset_id_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_datapoints_by_dataset_id_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_datapoints_by_dataset_id_endpoint_paged_result_of_output.py index bbe8992cb1..d0104551b2 100644 --- a/src/rapidata/api_client/models/query_datapoints_by_dataset_id_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_datapoints_by_dataset_id_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_examples_for_audience_endpoint_output.py b/src/rapidata/api_client/models/query_examples_for_audience_endpoint_output.py index 759c163406..502a656f46 100644 --- a/src/rapidata/api_client/models/query_examples_for_audience_endpoint_output.py +++ b/src/rapidata/api_client/models/query_examples_for_audience_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_examples_for_audience_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_examples_for_audience_endpoint_paged_result_of_output.py index 0c74cfa55c..224aa806e1 100644 --- a/src/rapidata/api_client/models/query_examples_for_audience_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_examples_for_audience_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_external_audiences_endpoint_output.py b/src/rapidata/api_client/models/query_external_audiences_endpoint_output.py index d1f34175f4..f57b9b009b 100644 --- a/src/rapidata/api_client/models/query_external_audiences_endpoint_output.py +++ b/src/rapidata/api_client/models/query_external_audiences_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_external_audiences_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_external_audiences_endpoint_paged_result_of_output.py index e6d9ee28fd..8eabe917bb 100644 --- a/src/rapidata/api_client/models/query_external_audiences_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_external_audiences_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_flagged_rapids_endpoint_output.py b/src/rapidata/api_client/models/query_flagged_rapids_endpoint_output.py index e18b020830..7cc8e3728a 100644 --- a/src/rapidata/api_client/models/query_flagged_rapids_endpoint_output.py +++ b/src/rapidata/api_client/models/query_flagged_rapids_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_flagged_rapids_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_flagged_rapids_endpoint_paged_result_of_output.py index 832b0358fd..29748de595 100644 --- a/src/rapidata/api_client/models/query_flagged_rapids_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_flagged_rapids_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_flow_items_endpoint_output.py b/src/rapidata/api_client/models/query_flow_items_endpoint_output.py index 38f129a2b9..dd7f66c9bd 100644 --- a/src/rapidata/api_client/models/query_flow_items_endpoint_output.py +++ b/src/rapidata/api_client/models/query_flow_items_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_flow_items_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_flow_items_endpoint_paged_result_of_output.py index 085e895476..722c3ac3a9 100644 --- a/src/rapidata/api_client/models/query_flow_items_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_flow_items_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_flows_endpoint_output.py b/src/rapidata/api_client/models/query_flows_endpoint_output.py index c0ec5ee39c..390b82412e 100644 --- a/src/rapidata/api_client/models/query_flows_endpoint_output.py +++ b/src/rapidata/api_client/models/query_flows_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_flows_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_flows_endpoint_paged_result_of_output.py index 5fdd0aa14c..45ea10bcd3 100644 --- a/src/rapidata/api_client/models/query_flows_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_flows_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_invoices_endpoint_output.py b/src/rapidata/api_client/models/query_invoices_endpoint_output.py index 2266ec73eb..0ffe6a9df5 100644 --- a/src/rapidata/api_client/models/query_invoices_endpoint_output.py +++ b/src/rapidata/api_client/models/query_invoices_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_invoices_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_invoices_endpoint_paged_result_of_output.py index e9a13f520e..317b8620b3 100644 --- a/src/rapidata/api_client/models/query_invoices_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_invoices_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_job_definitions_endpoint_output.py b/src/rapidata/api_client/models/query_job_definitions_endpoint_output.py index 0fda03ecb3..aba7eaf6b3 100644 --- a/src/rapidata/api_client/models/query_job_definitions_endpoint_output.py +++ b/src/rapidata/api_client/models/query_job_definitions_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_job_definitions_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_job_definitions_endpoint_paged_result_of_output.py index f76e4549e8..472d455de6 100644 --- a/src/rapidata/api_client/models/query_job_definitions_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_job_definitions_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_job_revisions_endpoint_output.py b/src/rapidata/api_client/models/query_job_revisions_endpoint_output.py index d78438e287..9ceba525be 100644 --- a/src/rapidata/api_client/models/query_job_revisions_endpoint_output.py +++ b/src/rapidata/api_client/models/query_job_revisions_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_job_revisions_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_job_revisions_endpoint_paged_result_of_output.py index ec0130e9cf..6c4a76fbb8 100644 --- a/src/rapidata/api_client/models/query_job_revisions_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_job_revisions_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_jobs_endpoint_output.py b/src/rapidata/api_client/models/query_jobs_endpoint_output.py index 612add4342..89ed9e461c 100644 --- a/src/rapidata/api_client/models/query_jobs_endpoint_output.py +++ b/src/rapidata/api_client/models/query_jobs_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_jobs_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_jobs_endpoint_paged_result_of_output.py index 9d69accbdd..c0eb6f7e84 100644 --- a/src/rapidata/api_client/models/query_jobs_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_jobs_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_leaderboard_runs_endpoint_output.py b/src/rapidata/api_client/models/query_leaderboard_runs_endpoint_output.py index 8cd01453b5..d9cf05a0fb 100644 --- a/src/rapidata/api_client/models/query_leaderboard_runs_endpoint_output.py +++ b/src/rapidata/api_client/models/query_leaderboard_runs_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_leaderboard_runs_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_leaderboard_runs_endpoint_paged_result_of_output.py index e5b7df1f91..5125a25304 100644 --- a/src/rapidata/api_client/models/query_leaderboard_runs_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_leaderboard_runs_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_leaderboards_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/query_leaderboards_by_benchmark_endpoint_output.py index fd00a53720..0979b0a89b 100644 --- a/src/rapidata/api_client/models/query_leaderboards_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/query_leaderboards_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_leaderboards_by_benchmark_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_leaderboards_by_benchmark_endpoint_paged_result_of_output.py index 04f3f5737a..726bb41ad4 100644 --- a/src/rapidata/api_client/models/query_leaderboards_by_benchmark_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_leaderboards_by_benchmark_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_leaderboards_endpoint_output.py b/src/rapidata/api_client/models/query_leaderboards_endpoint_output.py index 2e703a5e58..6e0f5eed64 100644 --- a/src/rapidata/api_client/models/query_leaderboards_endpoint_output.py +++ b/src/rapidata/api_client/models/query_leaderboards_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_leaderboards_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_leaderboards_endpoint_paged_result_of_output.py index 02fbac1bad..f57ec32e91 100644 --- a/src/rapidata/api_client/models/query_leaderboards_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_leaderboards_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_managed_benchmarks_endpoint_output.py b/src/rapidata/api_client/models/query_managed_benchmarks_endpoint_output.py index 7561c214f3..51c4db7dc4 100644 --- a/src/rapidata/api_client/models/query_managed_benchmarks_endpoint_output.py +++ b/src/rapidata/api_client/models/query_managed_benchmarks_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_managed_benchmarks_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_managed_benchmarks_endpoint_paged_result_of_output.py index 581392f7e2..1bce79d77f 100644 --- a/src/rapidata/api_client/models/query_managed_benchmarks_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_managed_benchmarks_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output.py index a7ac2f4f74..266fed1448 100644 --- a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_corpus.py b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_corpus.py index 1ffbb19066..15c1b2e2d9 100644 --- a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_corpus.py +++ b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_corpus.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_leaderboard.py b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_leaderboard.py index 058db85d67..59de174436 100644 --- a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_leaderboard.py +++ b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_leaderboard.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_matchup.py b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_matchup.py index 687bb0765e..feb2967783 100644 --- a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_matchup.py +++ b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_matchup.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_prompt_details.py b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_prompt_details.py index 773e09daad..240fd461fc 100644 --- a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_prompt_details.py +++ b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_prompt_details.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_side.py b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_side.py index fa94ea5116..8fd0c22632 100644 --- a/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_side.py +++ b/src/rapidata/api_client/models/query_matchups_by_benchmark_endpoint_output_side.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_matrix_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/query_matrix_by_benchmark_endpoint_output.py index 81acdd46ed..cf4a8fbbee 100644 --- a/src/rapidata/api_client/models/query_matrix_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/query_matrix_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_matrix_by_leaderboard_endpoint_output.py b/src/rapidata/api_client/models/query_matrix_by_leaderboard_endpoint_output.py index 016a6140d0..436f1eaf8e 100644 --- a/src/rapidata/api_client/models/query_matrix_by_leaderboard_endpoint_output.py +++ b/src/rapidata/api_client/models/query_matrix_by_leaderboard_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_model.py b/src/rapidata/api_client/models/query_model.py deleted file mode 100644 index 9d47a9af0b..0000000000 --- a/src/rapidata/api_client/models/query_model.py +++ /dev/null @@ -1,124 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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 -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.pagination import Pagination -from rapidata.api_client.models.root_filter import RootFilter -from rapidata.api_client.models.sort_criterion import SortCriterion -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class QueryModel(LazyValidatedModel): - """ - QueryModel - """ # noqa: E501 - page: Optional[Pagination] = None - filter: Optional[RootFilter] = None - sort_criteria: Optional[List[SortCriterion]] = Field(default=None, alias="sortCriteria") - __properties: ClassVar[List[str]] = ["page", "filter", "sortCriteria"] - - # model_config is inherited from LazyValidatedModel - - - 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 QueryModel 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 page - if self.page: - _dict['page'] = self.page.to_dict() - # override the default output from pydantic by calling `to_dict()` of filter - if self.filter: - _dict['filter'] = self.filter.to_dict() - # override the default output from pydantic by calling `to_dict()` of each item in sort_criteria (list) - _items = [] - if self.sort_criteria: - for _item_sort_criteria in self.sort_criteria: - if _item_sort_criteria: - _items.append(_item_sort_criteria.to_dict()) - _dict['sortCriteria'] = _items - # set to None if page (nullable) is None - # and model_fields_set contains the field - if self.page is None and "page" in self.model_fields_set: - _dict['page'] = None - - # set to None if filter (nullable) is None - # and model_fields_set contains the field - if self.filter is None and "filter" in self.model_fields_set: - _dict['filter'] = None - - # set to None if sort_criteria (nullable) is None - # and model_fields_set contains the field - if self.sort_criteria is None and "sort_criteria" in self.model_fields_set: - _dict['sortCriteria'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of QueryModel from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "page": Pagination.from_dict(obj["page"]) if obj.get("page") is not None else None, - "filter": RootFilter.from_dict(obj["filter"]) if obj.get("filter") is not None else None, - "sortCriteria": [SortCriterion.from_dict(_item) for _item in obj["sortCriteria"]] if obj.get("sortCriteria") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/query_orders_endpoint_output.py b/src/rapidata/api_client/models/query_orders_endpoint_output.py index 6ec9fabfd5..53908b60b6 100644 --- a/src/rapidata/api_client/models/query_orders_endpoint_output.py +++ b/src/rapidata/api_client/models/query_orders_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_orders_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_orders_endpoint_paged_result_of_output.py index d8ee210612..41aec15d1b 100644 --- a/src/rapidata/api_client/models/query_orders_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_orders_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_organizations_endpoint_output.py b/src/rapidata/api_client/models/query_organizations_endpoint_output.py index af7bf51b90..935db4c222 100644 --- a/src/rapidata/api_client/models/query_organizations_endpoint_output.py +++ b/src/rapidata/api_client/models/query_organizations_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_organizations_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_organizations_endpoint_paged_result_of_output.py index e709f0af78..3ccb4539e6 100644 --- a/src/rapidata/api_client/models/query_organizations_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_organizations_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_owner_tier_overrides_endpoint_output.py b/src/rapidata/api_client/models/query_owner_tier_overrides_endpoint_output.py index a27dd4e0b5..298126fa13 100644 --- a/src/rapidata/api_client/models/query_owner_tier_overrides_endpoint_output.py +++ b/src/rapidata/api_client/models/query_owner_tier_overrides_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_participants_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/query_participants_by_benchmark_endpoint_output.py index d287e06089..71b87cbc92 100644 --- a/src/rapidata/api_client/models/query_participants_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/query_participants_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_participants_by_benchmark_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_participants_by_benchmark_endpoint_paged_result_of_output.py index d825da87cc..c362c7f172 100644 --- a/src/rapidata/api_client/models/query_participants_by_benchmark_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_participants_by_benchmark_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_participants_obsolete_endpoint_output.py b/src/rapidata/api_client/models/query_participants_obsolete_endpoint_output.py index 5030310abc..09ffefb9c0 100644 --- a/src/rapidata/api_client/models/query_participants_obsolete_endpoint_output.py +++ b/src/rapidata/api_client/models/query_participants_obsolete_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_participants_obsolete_endpoint_output_item.py b/src/rapidata/api_client/models/query_participants_obsolete_endpoint_output_item.py index 1077359339..094fb616c1 100644 --- a/src/rapidata/api_client/models/query_participants_obsolete_endpoint_output_item.py +++ b/src/rapidata/api_client/models/query_participants_obsolete_endpoint_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output.py index 73129dd67e..4e68f877e7 100644 --- a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_corpus.py b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_corpus.py index ea172515b7..2d7af90199 100644 --- a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_corpus.py +++ b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_corpus.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_entry.py b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_entry.py index 0e89a22c56..1be5026761 100644 --- a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_entry.py +++ b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_entry.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_entry_image.py b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_entry_image.py index 1c8281d956..f97e1d2e1d 100644 --- a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_entry_image.py +++ b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_entry_image.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_matrix.py b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_matrix.py index aa040db8dc..508fda30d5 100644 --- a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_matrix.py +++ b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_matrix.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_prompt.py b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_prompt.py index aa9c1dd9db..b48d4ec946 100644 --- a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_prompt.py +++ b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_prompt.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_prompt_details.py b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_prompt_details.py index 2cf4ef7e84..3fa4767589 100644 --- a/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_prompt_details.py +++ b/src/rapidata/api_client/models/query_prompt_ratings_by_benchmark_endpoint_output_prompt_details.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_public_job_definitions_endpoint_output.py b/src/rapidata/api_client/models/query_public_job_definitions_endpoint_output.py index 9bddac55d8..0c2dba8850 100644 --- a/src/rapidata/api_client/models/query_public_job_definitions_endpoint_output.py +++ b/src/rapidata/api_client/models/query_public_job_definitions_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_public_job_definitions_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_public_job_definitions_endpoint_paged_result_of_output.py index c2e50a0f8c..30f21cdc8c 100644 --- a/src/rapidata/api_client/models/query_public_job_definitions_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_public_job_definitions_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_published_benchmarks_endpoint_output.py b/src/rapidata/api_client/models/query_published_benchmarks_endpoint_output.py index 283523f947..97870c1141 100644 --- a/src/rapidata/api_client/models/query_published_benchmarks_endpoint_output.py +++ b/src/rapidata/api_client/models/query_published_benchmarks_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_published_benchmarks_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_published_benchmarks_endpoint_paged_result_of_output.py index 21ac5ec09a..2c2a5444c3 100644 --- a/src/rapidata/api_client/models/query_published_benchmarks_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_published_benchmarks_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_sample_generations_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/query_sample_generations_by_benchmark_endpoint_output.py index 53904018f5..6a8052ff39 100644 --- a/src/rapidata/api_client/models/query_sample_generations_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/query_sample_generations_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_sample_generations_by_benchmark_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_sample_generations_by_benchmark_endpoint_paged_result_of_output.py index c7eee343e6..e7a7b16999 100644 --- a/src/rapidata/api_client/models/query_sample_generations_by_benchmark_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_sample_generations_by_benchmark_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_signal_runs_endpoint_output.py b/src/rapidata/api_client/models/query_signal_runs_endpoint_output.py index 967830ecdf..d4fc042618 100644 --- a/src/rapidata/api_client/models/query_signal_runs_endpoint_output.py +++ b/src/rapidata/api_client/models/query_signal_runs_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_signal_runs_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_signal_runs_endpoint_paged_result_of_output.py index b497c21534..0f1134c64c 100644 --- a/src/rapidata/api_client/models/query_signal_runs_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_signal_runs_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_signals_endpoint_output.py b/src/rapidata/api_client/models/query_signals_endpoint_output.py index bd8a8abef0..3bb9ebb91d 100644 --- a/src/rapidata/api_client/models/query_signals_endpoint_output.py +++ b/src/rapidata/api_client/models/query_signals_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_signals_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_signals_endpoint_paged_result_of_output.py index b36601c926..eb6ec64365 100644 --- a/src/rapidata/api_client/models/query_signals_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_signals_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_standings_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/query_standings_by_benchmark_endpoint_output.py index 5089066a1d..4372c277f8 100644 --- a/src/rapidata/api_client/models/query_standings_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/query_standings_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_standings_by_benchmark_endpoint_output_item.py b/src/rapidata/api_client/models/query_standings_by_benchmark_endpoint_output_item.py index 0f988547f7..9881a4d97b 100644 --- a/src/rapidata/api_client/models/query_standings_by_benchmark_endpoint_output_item.py +++ b/src/rapidata/api_client/models/query_standings_by_benchmark_endpoint_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_standings_by_leaderboard_endpoint_output.py b/src/rapidata/api_client/models/query_standings_by_leaderboard_endpoint_output.py index 17b4f83a2a..aacf509a72 100644 --- a/src/rapidata/api_client/models/query_standings_by_leaderboard_endpoint_output.py +++ b/src/rapidata/api_client/models/query_standings_by_leaderboard_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_standings_by_leaderboard_endpoint_output_item.py b/src/rapidata/api_client/models/query_standings_by_leaderboard_endpoint_output_item.py index cfd16354f3..dbfdd42b9b 100644 --- a/src/rapidata/api_client/models/query_standings_by_leaderboard_endpoint_output_item.py +++ b/src/rapidata/api_client/models/query_standings_by_leaderboard_endpoint_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_standings_endpoint_output.py b/src/rapidata/api_client/models/query_standings_endpoint_output.py index 012ee09042..dcb5f9d72b 100644 --- a/src/rapidata/api_client/models/query_standings_endpoint_output.py +++ b/src/rapidata/api_client/models/query_standings_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_standings_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_standings_endpoint_paged_result_of_output.py index ebd60612b4..cd09d640d3 100644 --- a/src/rapidata/api_client/models/query_standings_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_standings_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_tags_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/query_tags_by_benchmark_endpoint_output.py index 76df136d0c..c8e9b77915 100644 --- a/src/rapidata/api_client/models/query_tags_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/query_tags_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_validation_feedbacks_endpoint_output.py b/src/rapidata/api_client/models/query_validation_feedbacks_endpoint_output.py index be56eb4439..3bf0a76e83 100644 --- a/src/rapidata/api_client/models/query_validation_feedbacks_endpoint_output.py +++ b/src/rapidata/api_client/models/query_validation_feedbacks_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_validation_feedbacks_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_validation_feedbacks_endpoint_paged_result_of_output.py index 0c64184072..c802a29a8d 100644 --- a/src/rapidata/api_client/models/query_validation_feedbacks_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_validation_feedbacks_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_validation_rapid_eligibility_endpoint_output.py b/src/rapidata/api_client/models/query_validation_rapid_eligibility_endpoint_output.py index f0844b054b..5c86cc11c0 100644 --- a/src/rapidata/api_client/models/query_validation_rapid_eligibility_endpoint_output.py +++ b/src/rapidata/api_client/models/query_validation_rapid_eligibility_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_validation_rapid_eligibility_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_validation_rapid_eligibility_endpoint_paged_result_of_output.py index dd1a202701..2122c64284 100644 --- a/src/rapidata/api_client/models/query_validation_rapid_eligibility_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_validation_rapid_eligibility_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_validation_sets_endpoint_output.py b/src/rapidata/api_client/models/query_validation_sets_endpoint_output.py index 383bfa5a2f..e88ea7dcc0 100644 --- a/src/rapidata/api_client/models/query_validation_sets_endpoint_output.py +++ b/src/rapidata/api_client/models/query_validation_sets_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_validation_sets_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_validation_sets_endpoint_paged_result_of_output.py index 7982b20fb5..16c8cb27ca 100644 --- a/src/rapidata/api_client/models/query_validation_sets_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_validation_sets_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_vouchers_endpoint_output.py b/src/rapidata/api_client/models/query_vouchers_endpoint_output.py index 938a81572c..bfb1b03c52 100644 --- a/src/rapidata/api_client/models/query_vouchers_endpoint_output.py +++ b/src/rapidata/api_client/models/query_vouchers_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_vouchers_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_vouchers_endpoint_paged_result_of_output.py index c422510a03..efc1fdc0ea 100644 --- a/src/rapidata/api_client/models/query_vouchers_endpoint_paged_result_of_output.py +++ b/src/rapidata/api_client/models/query_vouchers_endpoint_paged_result_of_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/query_workflows_endpoint_output.py b/src/rapidata/api_client/models/query_workflows_endpoint_output.py deleted file mode 100644 index a077da7699..0000000000 --- a/src/rapidata/api_client/models/query_workflows_endpoint_output.py +++ /dev/null @@ -1,92 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from typing import Any, ClassVar, Dict, List -from rapidata.api_client.models.i_workflow import IWorkflow -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class QueryWorkflowsEndpointOutput(LazyValidatedModel): - """ - QueryWorkflowsEndpointOutput - """ # noqa: E501 - workflow: IWorkflow = Field(description="The workflow.") - __properties: ClassVar[List[str]] = ["workflow"] - - # model_config is inherited from LazyValidatedModel - - - 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 QueryWorkflowsEndpointOutput 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 workflow - if self.workflow: - _dict['workflow'] = self.workflow.to_dict() - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of QueryWorkflowsEndpointOutput from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "workflow": IWorkflow.from_dict(obj["workflow"]) if obj.get("workflow") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/query_workflows_endpoint_paged_result_of_output.py b/src/rapidata/api_client/models/query_workflows_endpoint_paged_result_of_output.py deleted file mode 100644 index 01d1b6bc34..0000000000 --- a/src/rapidata/api_client/models/query_workflows_endpoint_paged_result_of_output.py +++ /dev/null @@ -1,104 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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, StrictInt -from typing import Any, ClassVar, Dict, List, Optional -from rapidata.api_client.models.query_workflows_endpoint_output import QueryWorkflowsEndpointOutput -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class QueryWorkflowsEndpointPagedResultOfOutput(LazyValidatedModel): - """ - QueryWorkflowsEndpointPagedResultOfOutput - """ # noqa: E501 - total: StrictInt - page: StrictInt - page_size: StrictInt = Field(alias="pageSize") - items: List[QueryWorkflowsEndpointOutput] - total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages") - __properties: ClassVar[List[str]] = ["total", "page", "pageSize", "items", "totalPages"] - - # model_config is inherited from LazyValidatedModel - - - 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 QueryWorkflowsEndpointPagedResultOfOutput 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 items (list) - _items = [] - if self.items: - for _item_items in self.items: - if _item_items: - _items.append(_item_items.to_dict()) - _dict['items'] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of QueryWorkflowsEndpointPagedResultOfOutput from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "total": obj.get("total"), - "page": obj.get("page"), - "pageSize": obj.get("pageSize"), - "items": [QueryWorkflowsEndpointOutput.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, - "totalPages": obj.get("totalPages") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/ranking_datapoint.py b/src/rapidata/api_client/models/ranking_datapoint.py index 06f48e7ed9..ba3294e4f9 100644 --- a/src/rapidata/api_client/models/ranking_datapoint.py +++ b/src/rapidata/api_client/models/ranking_datapoint.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/rapid_issue.py b/src/rapidata/api_client/models/rapid_issue.py index da71011412..75b7b36601 100644 --- a/src/rapidata/api_client/models/rapid_issue.py +++ b/src/rapidata/api_client/models/rapid_issue.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/rapid_state.py b/src/rapidata/api_client/models/rapid_state.py index 4bb3f43bb6..44a796a76d 100644 --- a/src/rapidata/api_client/models/rapid_state.py +++ b/src/rapidata/api_client/models/rapid_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/rating_grouping.py b/src/rapidata/api_client/models/rating_grouping.py index 18e5933107..93991ec9f6 100644 --- a/src/rapidata/api_client/models/rating_grouping.py +++ b/src/rapidata/api_client/models/rating_grouping.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/read_bridge_token_endpoint_keys_output.py b/src/rapidata/api_client/models/read_bridge_token_endpoint_keys_output.py index 796d71690d..7e446b827f 100644 --- a/src/rapidata/api_client/models/read_bridge_token_endpoint_keys_output.py +++ b/src/rapidata/api_client/models/read_bridge_token_endpoint_keys_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/read_bridge_token_endpoint_not_available_output.py b/src/rapidata/api_client/models/read_bridge_token_endpoint_not_available_output.py index a9c8921a67..00a5fde2a2 100644 --- a/src/rapidata/api_client/models/read_bridge_token_endpoint_not_available_output.py +++ b/src/rapidata/api_client/models/read_bridge_token_endpoint_not_available_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/rebalance_leaderboard_endpoint_input.py b/src/rapidata/api_client/models/rebalance_leaderboard_endpoint_input.py index 3204c3fff6..0283e62c3d 100644 --- a/src/rapidata/api_client/models/rebalance_leaderboard_endpoint_input.py +++ b/src/rapidata/api_client/models/rebalance_leaderboard_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/reconciliation_job_state.py b/src/rapidata/api_client/models/reconciliation_job_state.py index 5dcab3085c..c1fb699630 100644 --- a/src/rapidata/api_client/models/reconciliation_job_state.py +++ b/src/rapidata/api_client/models/reconciliation_job_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/reconciliation_timestamp_mode.py b/src/rapidata/api_client/models/reconciliation_timestamp_mode.py index 0079592d20..cf297d1236 100644 --- a/src/rapidata/api_client/models/reconciliation_timestamp_mode.py +++ b/src/rapidata/api_client/models/reconciliation_timestamp_mode.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/recreate_external_audiences_endpoint_input.py b/src/rapidata/api_client/models/recreate_external_audiences_endpoint_input.py index dd3388e3c6..2f17b5f2a4 100644 --- a/src/rapidata/api_client/models/recreate_external_audiences_endpoint_input.py +++ b/src/rapidata/api_client/models/recreate_external_audiences_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/replicate_model_parameter_type.py b/src/rapidata/api_client/models/replicate_model_parameter_type.py index 7372765c12..e8af507376 100644 --- a/src/rapidata/api_client/models/replicate_model_parameter_type.py +++ b/src/rapidata/api_client/models/replicate_model_parameter_type.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/report_rapid_endpoint_input.py b/src/rapidata/api_client/models/report_rapid_endpoint_input.py index 7801ac29af..96e494efb4 100644 --- a/src/rapidata/api_client/models/report_rapid_endpoint_input.py +++ b/src/rapidata/api_client/models/report_rapid_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/resettle_billing_period_endpoint_input.py b/src/rapidata/api_client/models/resettle_billing_period_endpoint_input.py index c6ffc3e3c2..2a6e62e1cb 100644 --- a/src/rapidata/api_client/models/resettle_billing_period_endpoint_input.py +++ b/src/rapidata/api_client/models/resettle_billing_period_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/resettle_billing_period_endpoint_output.py b/src/rapidata/api_client/models/resettle_billing_period_endpoint_output.py index d564de82cd..b9367ba1e8 100644 --- a/src/rapidata/api_client/models/resettle_billing_period_endpoint_output.py +++ b/src/rapidata/api_client/models/resettle_billing_period_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/response_tally.py b/src/rapidata/api_client/models/response_tally.py index cb10360d11..34d7e58e75 100644 --- a/src/rapidata/api_client/models/response_tally.py +++ b/src/rapidata/api_client/models/response_tally.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/restart_rapids_endpoint_input.py b/src/rapidata/api_client/models/restart_rapids_endpoint_input.py index 23895059ab..c02a4abc35 100644 --- a/src/rapidata/api_client/models/restart_rapids_endpoint_input.py +++ b/src/rapidata/api_client/models/restart_rapids_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/retrieval_mode.py b/src/rapidata/api_client/models/retrieval_mode.py index 9a8022a5c0..d4bc02892b 100644 --- a/src/rapidata/api_client/models/retrieval_mode.py +++ b/src/rapidata/api_client/models/retrieval_mode.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/retry_sample_generation_endpoint_input.py b/src/rapidata/api_client/models/retry_sample_generation_endpoint_input.py index ff0c96abc6..bacc7db0a4 100644 --- a/src/rapidata/api_client/models/retry_sample_generation_endpoint_input.py +++ b/src/rapidata/api_client/models/retry_sample_generation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/retry_sample_generation_endpoint_output.py b/src/rapidata/api_client/models/retry_sample_generation_endpoint_output.py index 2a5e0a5f4d..6554014073 100644 --- a/src/rapidata/api_client/models/retry_sample_generation_endpoint_output.py +++ b/src/rapidata/api_client/models/retry_sample_generation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/review_reason.py b/src/rapidata/api_client/models/review_reason.py index 2bed096832..0fb4e36ac5 100644 --- a/src/rapidata/api_client/models/review_reason.py +++ b/src/rapidata/api_client/models/review_reason.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/revoke_bidder_relation_endpoint_input.py b/src/rapidata/api_client/models/revoke_bidder_relation_endpoint_input.py index 006aa45b5d..8e3998d99b 100644 --- a/src/rapidata/api_client/models/revoke_bidder_relation_endpoint_input.py +++ b/src/rapidata/api_client/models/revoke_bidder_relation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/revoke_external_app_relation_endpoint_input.py b/src/rapidata/api_client/models/revoke_external_app_relation_endpoint_input.py index a37255f82b..55041b3e28 100644 --- a/src/rapidata/api_client/models/revoke_external_app_relation_endpoint_input.py +++ b/src/rapidata/api_client/models/revoke_external_app_relation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/revoke_platform_relation_endpoint_input.py b/src/rapidata/api_client/models/revoke_platform_relation_endpoint_input.py index 0701b0d3e0..7b0e0a17c6 100644 --- a/src/rapidata/api_client/models/revoke_platform_relation_endpoint_input.py +++ b/src/rapidata/api_client/models/revoke_platform_relation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/root_filter.py b/src/rapidata/api_client/models/root_filter.py deleted file mode 100644 index c0e60e9f6a..0000000000 --- a/src/rapidata/api_client/models/root_filter.py +++ /dev/null @@ -1,100 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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 -from rapidata.api_client.models.filter import Filter -from rapidata.api_client.models.logic_operator import LogicOperator -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class RootFilter(LazyValidatedModel): - """ - RootFilter - """ # noqa: E501 - filters: List[Filter] - logic: LogicOperator - __properties: ClassVar[List[str]] = ["filters", "logic"] - - # model_config is inherited from LazyValidatedModel - - - 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 RootFilter 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 filters (list) - _items = [] - if self.filters: - for _item_filters in self.filters: - if _item_filters: - _items.append(_item_filters.to_dict()) - _dict['filters'] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of RootFilter from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "filters": [Filter.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None, - "logic": obj.get("logic") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/run_status.py b/src/rapidata/api_client/models/run_status.py index cc0a4a0d19..bd0fe19932 100644 --- a/src/rapidata/api_client/models/run_status.py +++ b/src/rapidata/api_client/models/run_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/sample_generation_item_status.py b/src/rapidata/api_client/models/sample_generation_item_status.py index c4467e8494..e4b9fd0ea4 100644 --- a/src/rapidata/api_client/models/sample_generation_item_status.py +++ b/src/rapidata/api_client/models/sample_generation_item_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/sample_generation_status.py b/src/rapidata/api_client/models/sample_generation_status.py index 261da7c472..5b35168096 100644 --- a/src/rapidata/api_client/models/sample_generation_status.py +++ b/src/rapidata/api_client/models/sample_generation_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/scrub_truth_scrub_range.py b/src/rapidata/api_client/models/scrub_truth_scrub_range.py index 90dcb185a8..a9fc7ecd17 100644 --- a/src/rapidata/api_client/models/scrub_truth_scrub_range.py +++ b/src/rapidata/api_client/models/scrub_truth_scrub_range.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/search_replicate_models_endpoint_model.py b/src/rapidata/api_client/models/search_replicate_models_endpoint_model.py index 414634167d..c6c475f228 100644 --- a/src/rapidata/api_client/models/search_replicate_models_endpoint_model.py +++ b/src/rapidata/api_client/models/search_replicate_models_endpoint_model.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/search_replicate_models_endpoint_output.py b/src/rapidata/api_client/models/search_replicate_models_endpoint_output.py index cd515245e8..5bc586d242 100644 --- a/src/rapidata/api_client/models/search_replicate_models_endpoint_output.py +++ b/src/rapidata/api_client/models/search_replicate_models_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/send_survey_endpoint_input.py b/src/rapidata/api_client/models/send_survey_endpoint_input.py index 70b1687c46..c1552932c1 100644 --- a/src/rapidata/api_client/models/send_survey_endpoint_input.py +++ b/src/rapidata/api_client/models/send_survey_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/set_fast_bid_multiplier_endpoint_input.py b/src/rapidata/api_client/models/set_fast_bid_multiplier_endpoint_input.py index 42f475aade..902ee89354 100644 --- a/src/rapidata/api_client/models/set_fast_bid_multiplier_endpoint_input.py +++ b/src/rapidata/api_client/models/set_fast_bid_multiplier_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/set_fast_bid_multiplier_endpoint_output.py b/src/rapidata/api_client/models/set_fast_bid_multiplier_endpoint_output.py index fdca58deb5..12329f9ae6 100644 --- a/src/rapidata/api_client/models/set_fast_bid_multiplier_endpoint_output.py +++ b/src/rapidata/api_client/models/set_fast_bid_multiplier_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/set_manual_global_boost_level_endpoint_input.py b/src/rapidata/api_client/models/set_manual_global_boost_level_endpoint_input.py index c45ee25de4..5cd5d6643e 100644 --- a/src/rapidata/api_client/models/set_manual_global_boost_level_endpoint_input.py +++ b/src/rapidata/api_client/models/set_manual_global_boost_level_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/set_minimum_spend_commitment_endpoint_input.py b/src/rapidata/api_client/models/set_minimum_spend_commitment_endpoint_input.py index 6f12a6b61d..ca37b4faa2 100644 --- a/src/rapidata/api_client/models/set_minimum_spend_commitment_endpoint_input.py +++ b/src/rapidata/api_client/models/set_minimum_spend_commitment_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/set_organization_credit_line_endpoint_input.py b/src/rapidata/api_client/models/set_organization_credit_line_endpoint_input.py index 92c6142f15..73433c4ecc 100644 --- a/src/rapidata/api_client/models/set_organization_credit_line_endpoint_input.py +++ b/src/rapidata/api_client/models/set_organization_credit_line_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/set_organization_support_slack_channel_endpoint_input.py b/src/rapidata/api_client/models/set_organization_support_slack_channel_endpoint_input.py index b2c9c6dc64..125cdff368 100644 --- a/src/rapidata/api_client/models/set_organization_support_slack_channel_endpoint_input.py +++ b/src/rapidata/api_client/models/set_organization_support_slack_channel_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/set_platform_fee_endpoint_input.py b/src/rapidata/api_client/models/set_platform_fee_endpoint_input.py index 3b967ad848..7db8fa1098 100644 --- a/src/rapidata/api_client/models/set_platform_fee_endpoint_input.py +++ b/src/rapidata/api_client/models/set_platform_fee_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/shorten_context_endpoint_input.py b/src/rapidata/api_client/models/shorten_context_endpoint_input.py index be815026c8..af57c37ae1 100644 --- a/src/rapidata/api_client/models/shorten_context_endpoint_input.py +++ b/src/rapidata/api_client/models/shorten_context_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/shorten_context_endpoint_input_item.py b/src/rapidata/api_client/models/shorten_context_endpoint_input_item.py index 556d74a1c5..4f7b97ba5e 100644 --- a/src/rapidata/api_client/models/shorten_context_endpoint_input_item.py +++ b/src/rapidata/api_client/models/shorten_context_endpoint_input_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/shorten_context_endpoint_output.py b/src/rapidata/api_client/models/shorten_context_endpoint_output.py index d226536df6..146900c4e9 100644 --- a/src/rapidata/api_client/models/shorten_context_endpoint_output.py +++ b/src/rapidata/api_client/models/shorten_context_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/shorten_context_endpoint_output_item.py b/src/rapidata/api_client/models/shorten_context_endpoint_output_item.py index dfeb560f44..9bd2cd690e 100644 --- a/src/rapidata/api_client/models/shorten_context_endpoint_output_item.py +++ b/src/rapidata/api_client/models/shorten_context_endpoint_output_item.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/signal_run_status.py b/src/rapidata/api_client/models/signal_run_status.py index 3d087af3e2..cc73e6a529 100644 --- a/src/rapidata/api_client/models/signal_run_status.py +++ b/src/rapidata/api_client/models/signal_run_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/signal_run_trigger_source.py b/src/rapidata/api_client/models/signal_run_trigger_source.py index 1ac55fa89e..ccf68079ee 100644 --- a/src/rapidata/api_client/models/signal_run_trigger_source.py +++ b/src/rapidata/api_client/models/signal_run_trigger_source.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/simplified_audience_user_state.py b/src/rapidata/api_client/models/simplified_audience_user_state.py index 9d5816ac47..e1353800ad 100644 --- a/src/rapidata/api_client/models/simplified_audience_user_state.py +++ b/src/rapidata/api_client/models/simplified_audience_user_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/skip_rapid_endpoint_input.py b/src/rapidata/api_client/models/skip_rapid_endpoint_input.py index 3b80eb60fb..e17dc23113 100644 --- a/src/rapidata/api_client/models/skip_rapid_endpoint_input.py +++ b/src/rapidata/api_client/models/skip_rapid_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/skip_rapid_endpoint_output.py b/src/rapidata/api_client/models/skip_rapid_endpoint_output.py index 89b81e687b..ba7ae46859 100644 --- a/src/rapidata/api_client/models/skip_rapid_endpoint_output.py +++ b/src/rapidata/api_client/models/skip_rapid_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/sort_criteria.py b/src/rapidata/api_client/models/sort_criteria.py deleted file mode 100644 index 1b5121dc58..0000000000 --- a/src/rapidata/api_client/models/sort_criteria.py +++ /dev/null @@ -1,102 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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 rapidata.api_client.models.sort_criterion import SortCriterion -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class SortCriteria(LazyValidatedModel): - """ - SortCriteria - """ # noqa: E501 - criteria: Optional[List[SortCriterion]] = None - __properties: ClassVar[List[str]] = ["criteria"] - - # model_config is inherited from LazyValidatedModel - - - 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 SortCriteria 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 criteria (list) - _items = [] - if self.criteria: - for _item_criteria in self.criteria: - if _item_criteria: - _items.append(_item_criteria.to_dict()) - _dict['criteria'] = _items - # set to None if criteria (nullable) is None - # and model_fields_set contains the field - if self.criteria is None and "criteria" in self.model_fields_set: - _dict['criteria'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of SortCriteria from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "criteria": [SortCriterion.from_dict(_item) for _item in obj["criteria"]] if obj.get("criteria") is not None else None - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/sort_criterion.py b/src/rapidata/api_client/models/sort_criterion.py deleted file mode 100644 index 931dd10f98..0000000000 --- a/src/rapidata/api_client/models/sort_criterion.py +++ /dev/null @@ -1,92 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: v1 - 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 -from rapidata.api_client.models.sort_direction import SortDirection -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class SortCriterion(LazyValidatedModel): - """ - SortCriterion - """ # noqa: E501 - property_name: StrictStr = Field(alias="propertyName") - direction: SortDirection - __properties: ClassVar[List[str]] = ["propertyName", "direction"] - - # model_config is inherited from LazyValidatedModel - - - 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 SortCriterion 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 SortCriterion from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "propertyName": obj.get("propertyName"), - "direction": obj.get("direction") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/sort_direction.py b/src/rapidata/api_client/models/sort_direction.py index a4e1a0de96..b40f10a205 100644 --- a/src/rapidata/api_client/models/sort_direction.py +++ b/src/rapidata/api_client/models/sort_direction.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/standing_status.py b/src/rapidata/api_client/models/standing_status.py index 460cf7c197..dd1a88afbe 100644 --- a/src/rapidata/api_client/models/standing_status.py +++ b/src/rapidata/api_client/models/standing_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/start_audience_inactivity_sync_endpoint_output.py b/src/rapidata/api_client/models/start_audience_inactivity_sync_endpoint_output.py index f5adcc4c28..a7f42b15ba 100644 --- a/src/rapidata/api_client/models/start_audience_inactivity_sync_endpoint_output.py +++ b/src/rapidata/api_client/models/start_audience_inactivity_sync_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/start_audience_state_recalculation_endpoint_output.py b/src/rapidata/api_client/models/start_audience_state_recalculation_endpoint_output.py index ec3c33af6a..514bdbc082 100644 --- a/src/rapidata/api_client/models/start_audience_state_recalculation_endpoint_output.py +++ b/src/rapidata/api_client/models/start_audience_state_recalculation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/start_benchmark_hugging_face_sync_endpoint_input.py b/src/rapidata/api_client/models/start_benchmark_hugging_face_sync_endpoint_input.py index 3695e34ab2..bc12acb6cf 100644 --- a/src/rapidata/api_client/models/start_benchmark_hugging_face_sync_endpoint_input.py +++ b/src/rapidata/api_client/models/start_benchmark_hugging_face_sync_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/start_benchmark_hugging_face_sync_endpoint_output.py b/src/rapidata/api_client/models/start_benchmark_hugging_face_sync_endpoint_output.py index 65a0420bbb..0f9c7f5a5c 100644 --- a/src/rapidata/api_client/models/start_benchmark_hugging_face_sync_endpoint_output.py +++ b/src/rapidata/api_client/models/start_benchmark_hugging_face_sync_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/start_bulk_reconciliation_endpoint_input.py b/src/rapidata/api_client/models/start_bulk_reconciliation_endpoint_input.py index 575342a692..2ebe553605 100644 --- a/src/rapidata/api_client/models/start_bulk_reconciliation_endpoint_input.py +++ b/src/rapidata/api_client/models/start_bulk_reconciliation_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/start_bulk_reconciliation_endpoint_output.py b/src/rapidata/api_client/models/start_bulk_reconciliation_endpoint_output.py index 7f7fc7b3f6..7f4b962035 100644 --- a/src/rapidata/api_client/models/start_bulk_reconciliation_endpoint_output.py +++ b/src/rapidata/api_client/models/start_bulk_reconciliation_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/start_preliminary_download_endpoint_input.py b/src/rapidata/api_client/models/start_preliminary_download_endpoint_input.py deleted file mode 100644 index d6ed90e2ac..0000000000 --- a/src/rapidata/api_client/models/start_preliminary_download_endpoint_input.py +++ /dev/null @@ -1,88 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from typing import Any, ClassVar, Dict, List, Optional -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class StartPreliminaryDownloadEndpointInput(LazyValidatedModel): - """ - StartPreliminaryDownloadEndpointInput - """ # noqa: E501 - send_email: Optional[StrictBool] = Field(default=None, description="Whether to email the user when the download is ready.", alias="sendEmail") - __properties: ClassVar[List[str]] = ["sendEmail"] - - # model_config is inherited from LazyValidatedModel - - - 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 StartPreliminaryDownloadEndpointInput 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 StartPreliminaryDownloadEndpointInput from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "sendEmail": obj.get("sendEmail") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/start_preliminary_download_endpoint_output.py b/src/rapidata/api_client/models/start_preliminary_download_endpoint_output.py deleted file mode 100644 index ff70c3b7d7..0000000000 --- a/src/rapidata/api_client/models/start_preliminary_download_endpoint_output.py +++ /dev/null @@ -1,88 +0,0 @@ -# coding: utf-8 - -""" - Rapidata Asset API - - The API for the Rapidata Asset service - - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 - 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 -from pydantic import ValidationError -from rapidata.api_client.lazy_model import LazyValidatedModel -from typing import Optional, Set -from typing_extensions import Self - -class StartPreliminaryDownloadEndpointOutput(LazyValidatedModel): - """ - StartPreliminaryDownloadEndpointOutput - """ # noqa: E501 - download_id: StrictStr = Field(description="The id of the preliminary download that was initiated.", alias="downloadId") - __properties: ClassVar[List[str]] = ["downloadId"] - - # model_config is inherited from LazyValidatedModel - - - 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 StartPreliminaryDownloadEndpointOutput 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 StartPreliminaryDownloadEndpointOutput from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _data = { - "downloadId": obj.get("downloadId") - } - try: - _obj = cls.model_validate(_data) - except ValidationError as _val_error: - _obj = cls._lazy_construct(_data, _val_error) - return _obj - - diff --git a/src/rapidata/api_client/models/sticky_config.py b/src/rapidata/api_client/models/sticky_config.py index 69b38e0fbb..30db8c97f7 100644 --- a/src/rapidata/api_client/models/sticky_config.py +++ b/src/rapidata/api_client/models/sticky_config.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/sticky_state.py b/src/rapidata/api_client/models/sticky_state.py index 40dc2662b3..117894b1c6 100644 --- a/src/rapidata/api_client/models/sticky_state.py +++ b/src/rapidata/api_client/models/sticky_state.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/submit_feedback_endpoint_input.py b/src/rapidata/api_client/models/submit_feedback_endpoint_input.py index 75fb65deac..1a08dbc62f 100644 --- a/src/rapidata/api_client/models/submit_feedback_endpoint_input.py +++ b/src/rapidata/api_client/models/submit_feedback_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/submit_order_endpoint_input.py b/src/rapidata/api_client/models/submit_order_endpoint_input.py index 6110bd9308..7b88d81e08 100644 --- a/src/rapidata/api_client/models/submit_order_endpoint_input.py +++ b/src/rapidata/api_client/models/submit_order_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/submit_participant_by_benchmark_endpoint_output.py b/src/rapidata/api_client/models/submit_participant_by_benchmark_endpoint_output.py index 57c736f3e2..2b921128a6 100644 --- a/src/rapidata/api_client/models/submit_participant_by_benchmark_endpoint_output.py +++ b/src/rapidata/api_client/models/submit_participant_by_benchmark_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/submit_participant_endpoint_output.py b/src/rapidata/api_client/models/submit_participant_endpoint_output.py index a1f7653ac1..f0932e9367 100644 --- a/src/rapidata/api_client/models/submit_participant_endpoint_output.py +++ b/src/rapidata/api_client/models/submit_participant_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/subscribe_to_newsletter_endpoint_input.py b/src/rapidata/api_client/models/subscribe_to_newsletter_endpoint_input.py index 20c7446f59..a68897f968 100644 --- a/src/rapidata/api_client/models/subscribe_to_newsletter_endpoint_input.py +++ b/src/rapidata/api_client/models/subscribe_to_newsletter_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/switch_active_organization_endpoint_input.py b/src/rapidata/api_client/models/switch_active_organization_endpoint_input.py index 8e30cbb393..5448b38bc3 100644 --- a/src/rapidata/api_client/models/switch_active_organization_endpoint_input.py +++ b/src/rapidata/api_client/models/switch_active_organization_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/tag.py b/src/rapidata/api_client/models/tag.py index 075b1c79c5..78c4b2e896 100644 --- a/src/rapidata/api_client/models/tag.py +++ b/src/rapidata/api_client/models/tag.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/tag_summary.py b/src/rapidata/api_client/models/tag_summary.py index b09955fcfc..5a9c0f801a 100644 --- a/src/rapidata/api_client/models/tag_summary.py +++ b/src/rapidata/api_client/models/tag_summary.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/time_grouping.py b/src/rapidata/api_client/models/time_grouping.py index c7434c5525..fd5dc0dd48 100644 --- a/src/rapidata/api_client/models/time_grouping.py +++ b/src/rapidata/api_client/models/time_grouping.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/transcription_payload_transcription_word.py b/src/rapidata/api_client/models/transcription_payload_transcription_word.py index 29de3f1150..848bd37ba4 100644 --- a/src/rapidata/api_client/models/transcription_payload_transcription_word.py +++ b/src/rapidata/api_client/models/transcription_payload_transcription_word.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/transcription_rapid_transcription_word.py b/src/rapidata/api_client/models/transcription_rapid_transcription_word.py index 4c74ab3d89..a0f7de0045 100644 --- a/src/rapidata/api_client/models/transcription_rapid_transcription_word.py +++ b/src/rapidata/api_client/models/transcription_rapid_transcription_word.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/transcription_result_transcription_word.py b/src/rapidata/api_client/models/transcription_result_transcription_word.py index 842797677c..5a5c887ff1 100644 --- a/src/rapidata/api_client/models/transcription_result_transcription_word.py +++ b/src/rapidata/api_client/models/transcription_result_transcription_word.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/transcription_truth_transcription_word.py b/src/rapidata/api_client/models/transcription_truth_transcription_word.py index 865f4035ce..4949abb5eb 100644 --- a/src/rapidata/api_client/models/transcription_truth_transcription_word.py +++ b/src/rapidata/api_client/models/transcription_truth_transcription_word.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/translate_endpoint_input.py b/src/rapidata/api_client/models/translate_endpoint_input.py index d7a24ed894..91501e66be 100644 --- a/src/rapidata/api_client/models/translate_endpoint_input.py +++ b/src/rapidata/api_client/models/translate_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/translate_endpoint_output.py b/src/rapidata/api_client/models/translate_endpoint_output.py index 6402cc9a37..5d56e289df 100644 --- a/src/rapidata/api_client/models/translate_endpoint_output.py +++ b/src/rapidata/api_client/models/translate_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/translated_string.py b/src/rapidata/api_client/models/translated_string.py index d8770899cd..c71347997a 100644 --- a/src/rapidata/api_client/models/translated_string.py +++ b/src/rapidata/api_client/models/translated_string.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/translator_type.py b/src/rapidata/api_client/models/translator_type.py index f1b3e50831..9ef0110ac9 100644 --- a/src/rapidata/api_client/models/translator_type.py +++ b/src/rapidata/api_client/models/translator_type.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/trigger_signal_endpoint_output.py b/src/rapidata/api_client/models/trigger_signal_endpoint_output.py index 057de2d5c3..a10a60bc41 100644 --- a/src/rapidata/api_client/models/trigger_signal_endpoint_output.py +++ b/src/rapidata/api_client/models/trigger_signal_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/unlock_order_endpoint_output.py b/src/rapidata/api_client/models/unlock_order_endpoint_output.py index 5b8e8ebdee..d0c2402079 100644 --- a/src/rapidata/api_client/models/unlock_order_endpoint_output.py +++ b/src/rapidata/api_client/models/unlock_order_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/unsubscribe_from_newsletter_endpoint_input.py b/src/rapidata/api_client/models/unsubscribe_from_newsletter_endpoint_input.py index 68b758c70a..8f8f89a5ee 100644 --- a/src/rapidata/api_client/models/unsubscribe_from_newsletter_endpoint_input.py +++ b/src/rapidata/api_client/models/unsubscribe_from_newsletter_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_audience_endpoint_input.py b/src/rapidata/api_client/models/update_audience_endpoint_input.py index 66a3a9bd47..ae3b3497d3 100644 --- a/src/rapidata/api_client/models/update_audience_endpoint_input.py +++ b/src/rapidata/api_client/models/update_audience_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_audience_endpoint_output.py b/src/rapidata/api_client/models/update_audience_endpoint_output.py index c583e263c3..7742997577 100644 --- a/src/rapidata/api_client/models/update_audience_endpoint_output.py +++ b/src/rapidata/api_client/models/update_audience_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_audience_example_endpoint_input.py b/src/rapidata/api_client/models/update_audience_example_endpoint_input.py index 428ad408db..b4c8c2ee6f 100644 --- a/src/rapidata/api_client/models/update_audience_example_endpoint_input.py +++ b/src/rapidata/api_client/models/update_audience_example_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_benchmark_endpoint_input.py b/src/rapidata/api_client/models/update_benchmark_endpoint_input.py index 49a145bfd4..a9a8d618a6 100644 --- a/src/rapidata/api_client/models/update_benchmark_endpoint_input.py +++ b/src/rapidata/api_client/models/update_benchmark_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_benchmark_name_endpoint_input.py b/src/rapidata/api_client/models/update_benchmark_name_endpoint_input.py index a54e6a18af..1d814611b5 100644 --- a/src/rapidata/api_client/models/update_benchmark_name_endpoint_input.py +++ b/src/rapidata/api_client/models/update_benchmark_name_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_boost_config_endpoint_input.py b/src/rapidata/api_client/models/update_boost_config_endpoint_input.py index b70dfd4ff4..87adc50fc6 100644 --- a/src/rapidata/api_client/models/update_boost_config_endpoint_input.py +++ b/src/rapidata/api_client/models/update_boost_config_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_boost_config_endpoint_output.py b/src/rapidata/api_client/models/update_boost_config_endpoint_output.py index 8e80a2cb0f..f110177bed 100644 --- a/src/rapidata/api_client/models/update_boost_config_endpoint_output.py +++ b/src/rapidata/api_client/models/update_boost_config_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_campaign_endpoint_input.py b/src/rapidata/api_client/models/update_campaign_endpoint_input.py index 0493297576..3496e54b83 100644 --- a/src/rapidata/api_client/models/update_campaign_endpoint_input.py +++ b/src/rapidata/api_client/models/update_campaign_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_config_endpoint_input.py b/src/rapidata/api_client/models/update_config_endpoint_input.py index 6a17f8231d..86ca46fdb3 100644 --- a/src/rapidata/api_client/models/update_config_endpoint_input.py +++ b/src/rapidata/api_client/models/update_config_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_dataset_name_endpoint_input.py b/src/rapidata/api_client/models/update_dataset_name_endpoint_input.py index e77353c7da..6f4ffabe01 100644 --- a/src/rapidata/api_client/models/update_dataset_name_endpoint_input.py +++ b/src/rapidata/api_client/models/update_dataset_name_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_global_text_endpoint_input.py b/src/rapidata/api_client/models/update_global_text_endpoint_input.py index aeb15db727..a34f1b39ba 100644 --- a/src/rapidata/api_client/models/update_global_text_endpoint_input.py +++ b/src/rapidata/api_client/models/update_global_text_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_job_definition_endpoint_input.py b/src/rapidata/api_client/models/update_job_definition_endpoint_input.py index 68f0336ea8..3af75d74da 100644 --- a/src/rapidata/api_client/models/update_job_definition_endpoint_input.py +++ b/src/rapidata/api_client/models/update_job_definition_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_job_endpoint_input.py b/src/rapidata/api_client/models/update_job_endpoint_input.py index 67edbf6cb6..654877b9f0 100644 --- a/src/rapidata/api_client/models/update_job_endpoint_input.py +++ b/src/rapidata/api_client/models/update_job_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_leaderboard_endpoint_input.py b/src/rapidata/api_client/models/update_leaderboard_endpoint_input.py index 94cc230340..d4f9b411a9 100644 --- a/src/rapidata/api_client/models/update_leaderboard_endpoint_input.py +++ b/src/rapidata/api_client/models/update_leaderboard_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_leaderboard_name_endpoint_input.py b/src/rapidata/api_client/models/update_leaderboard_name_endpoint_input.py index d23c2b0fb4..a23f327f9a 100644 --- a/src/rapidata/api_client/models/update_leaderboard_name_endpoint_input.py +++ b/src/rapidata/api_client/models/update_leaderboard_name_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_leaderboard_response_config_endpoint_input.py b/src/rapidata/api_client/models/update_leaderboard_response_config_endpoint_input.py index 5dad51e811..e16bed6bfb 100644 --- a/src/rapidata/api_client/models/update_leaderboard_response_config_endpoint_input.py +++ b/src/rapidata/api_client/models/update_leaderboard_response_config_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_order_endpoint_input.py b/src/rapidata/api_client/models/update_order_endpoint_input.py index e8b7e25c48..f980783603 100644 --- a/src/rapidata/api_client/models/update_order_endpoint_input.py +++ b/src/rapidata/api_client/models/update_order_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_organization_endpoint_input.py b/src/rapidata/api_client/models/update_organization_endpoint_input.py index c158011f5a..5f306cbc3f 100644 --- a/src/rapidata/api_client/models/update_organization_endpoint_input.py +++ b/src/rapidata/api_client/models/update_organization_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_owner_tier_override_endpoint_input.py b/src/rapidata/api_client/models/update_owner_tier_override_endpoint_input.py index 7756f8471e..e14d864b9a 100644 --- a/src/rapidata/api_client/models/update_owner_tier_override_endpoint_input.py +++ b/src/rapidata/api_client/models/update_owner_tier_override_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_participant_endpoint_input.py b/src/rapidata/api_client/models/update_participant_endpoint_input.py index 11eccbf39e..6aeb9855c8 100644 --- a/src/rapidata/api_client/models/update_participant_endpoint_input.py +++ b/src/rapidata/api_client/models/update_participant_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_participant_name_endpoint_input.py b/src/rapidata/api_client/models/update_participant_name_endpoint_input.py index 8ce7060dd3..bcbc00f922 100644 --- a/src/rapidata/api_client/models/update_participant_name_endpoint_input.py +++ b/src/rapidata/api_client/models/update_participant_name_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_prompt_tags_endpoint_input.py b/src/rapidata/api_client/models/update_prompt_tags_endpoint_input.py index 5a7028d0ca..aeeded85e6 100644 --- a/src/rapidata/api_client/models/update_prompt_tags_endpoint_input.py +++ b/src/rapidata/api_client/models/update_prompt_tags_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_signal_endpoint_input.py b/src/rapidata/api_client/models/update_signal_endpoint_input.py index 63a94ca0ef..37ce1bf1bd 100644 --- a/src/rapidata/api_client/models/update_signal_endpoint_input.py +++ b/src/rapidata/api_client/models/update_signal_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_stream_program_endpoint_input.py b/src/rapidata/api_client/models/update_stream_program_endpoint_input.py index 5b6d7ab882..50208ab5a6 100644 --- a/src/rapidata/api_client/models/update_stream_program_endpoint_input.py +++ b/src/rapidata/api_client/models/update_stream_program_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_validation_rapid_endpoint_input.py b/src/rapidata/api_client/models/update_validation_rapid_endpoint_input.py index 30eb2db8f1..263d2d4cda 100644 --- a/src/rapidata/api_client/models/update_validation_rapid_endpoint_input.py +++ b/src/rapidata/api_client/models/update_validation_rapid_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_validation_set_dimensions_endpoint_input.py b/src/rapidata/api_client/models/update_validation_set_dimensions_endpoint_input.py index abb2208ab3..d756e5c435 100644 --- a/src/rapidata/api_client/models/update_validation_set_dimensions_endpoint_input.py +++ b/src/rapidata/api_client/models/update_validation_set_dimensions_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_validation_set_endpoint_input.py b/src/rapidata/api_client/models/update_validation_set_endpoint_input.py index 6020ec9930..6924ca67a3 100644 --- a/src/rapidata/api_client/models/update_validation_set_endpoint_input.py +++ b/src/rapidata/api_client/models/update_validation_set_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/update_validation_set_should_alert_endpoint_input.py b/src/rapidata/api_client/models/update_validation_set_should_alert_endpoint_input.py index a9fd0f0cb7..04eb811fbe 100644 --- a/src/rapidata/api_client/models/update_validation_set_should_alert_endpoint_input.py +++ b/src/rapidata/api_client/models/update_validation_set_should_alert_endpoint_input.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/upload_file_endpoint_output.py b/src/rapidata/api_client/models/upload_file_endpoint_output.py index 44ca7df092..e65e98f2db 100644 --- a/src/rapidata/api_client/models/upload_file_endpoint_output.py +++ b/src/rapidata/api_client/models/upload_file_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/upload_file_from_url_endpoint_output.py b/src/rapidata/api_client/models/upload_file_from_url_endpoint_output.py index 6c2fbd3397..0d8f12aee5 100644 --- a/src/rapidata/api_client/models/upload_file_from_url_endpoint_output.py +++ b/src/rapidata/api_client/models/upload_file_from_url_endpoint_output.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/user_attribute.py b/src/rapidata/api_client/models/user_attribute.py index 18372a9b7c..7df65fe3ec 100644 --- a/src/rapidata/api_client/models/user_attribute.py +++ b/src/rapidata/api_client/models/user_attribute.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/validation_chance.py b/src/rapidata/api_client/models/validation_chance.py index f68d1b4bc3..bbad3ae7b9 100644 --- a/src/rapidata/api_client/models/validation_chance.py +++ b/src/rapidata/api_client/models/validation_chance.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/validation_problem_details.py b/src/rapidata/api_client/models/validation_problem_details.py index 8599a34459..ae728961de 100644 --- a/src/rapidata/api_client/models/validation_problem_details.py +++ b/src/rapidata/api_client/models/validation_problem_details.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/vote_aggregation.py b/src/rapidata/api_client/models/vote_aggregation.py index 738770be65..00120af385 100644 --- a/src/rapidata/api_client/models/vote_aggregation.py +++ b/src/rapidata/api_client/models/vote_aggregation.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/vote_matrix_result.py b/src/rapidata/api_client/models/vote_matrix_result.py index bd5d23df63..50e505d460 100644 --- a/src/rapidata/api_client/models/vote_matrix_result.py +++ b/src/rapidata/api_client/models/vote_matrix_result.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/voucher_source.py b/src/rapidata/api_client/models/voucher_source.py index d95fadff3b..8812843972 100644 --- a/src/rapidata/api_client/models/voucher_source.py +++ b/src/rapidata/api_client/models/voucher_source.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/voucher_status.py b/src/rapidata/api_client/models/voucher_status.py index 11141d5915..88cd8270d3 100644 --- a/src/rapidata/api_client/models/voucher_status.py +++ b/src/rapidata/api_client/models/voucher_status.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/models/weighted_branch.py b/src/rapidata/api_client/models/weighted_branch.py index 8bd44e3303..cbe43a5766 100644 --- a/src/rapidata/api_client/models/weighted_branch.py +++ b/src/rapidata/api_client/models/weighted_branch.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client/rest.py b/src/rapidata/api_client/rest.py index 25617638a5..d72b5d2718 100644 --- a/src/rapidata/api_client/rest.py +++ b/src/rapidata/api_client/rest.py @@ -5,7 +5,7 @@ The API for the Rapidata Asset service - The version of the OpenAPI document: 2026.08.20.1843-f4aff59 + The version of the OpenAPI document: 2026.08.21.0757-4bc4250 Generated by OpenAPI Generator (https://openapi-generator.tech) Do not edit the class manually. diff --git a/src/rapidata/api_client_README.md b/src/rapidata/api_client_README.md index 6775560420..7e7d4c0b96 100644 --- a/src/rapidata/api_client_README.md +++ b/src/rapidata/api_client_README.md @@ -3,7 +3,7 @@ The API for the Rapidata Asset service The `rapidata.api_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 2026.08.20.1843-f4aff59 +- API version: 2026.08.21.0757-4bc4250 - Package version: 1.0.0 - Generator version: 7.23.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen @@ -368,9 +368,6 @@ Class | Method | HTTP request | Description *PaymentApi* | [**payment_session_session_id_get**](rapidata/api_client/docs/PaymentApi.md#payment_session_session_id_get) | **GET** /payment/session/{sessionId} | Gets the current status of a checkout session. *PaymentApi* | [**payment_topup_post**](rapidata/api_client/docs/PaymentApi.md#payment_topup_post) | **POST** /payment/topup | Creates a hosted checkout session for the authenticated customer to add the given amount to their prepaid balance. *PaymentApi* | [**payment_webhook_post**](rapidata/api_client/docs/PaymentApi.md#payment_webhook_post) | **POST** /payment/webhook | Processes an incoming Stripe webhook event. -*PipelineApi* | [**pipeline_pipeline_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_get) | **GET** /pipeline/{pipelineId} | Gets a pipeline by its id. -*PipelineApi* | [**pipeline_pipeline_id_preliminary_download_post**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_preliminary_download_post) | **POST** /pipeline/{pipelineId}/preliminary-download | Initiates a preliminary download of the pipeline. -*PipelineApi* | [**pipeline_preliminary_download_preliminary_download_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_preliminary_download_preliminary_download_id_get) | **GET** /pipeline/preliminary-download/{preliminaryDownloadId} | Streams the preliminary download file when ready. *PlatformApi* | [**authorization_relations_platform_delete**](rapidata/api_client/docs/PlatformApi.md#authorization_relations_platform_delete) | **DELETE** /authorization/relations/platform | Revokes a platform relation from a customer. *PlatformApi* | [**authorization_relations_platform_get**](rapidata/api_client/docs/PlatformApi.md#authorization_relations_platform_get) | **GET** /authorization/relations/platform | Lists the customers holding platform relations, one cursor page at a time. *PlatformApi* | [**authorization_relations_platform_put**](rapidata/api_client/docs/PlatformApi.md#authorization_relations_platform_put) | **PUT** /authorization/relations/platform | Grants a platform relation to a customer. @@ -448,9 +445,6 @@ Class | Method | HTTP request | Description *ValidationSetApi* | [**validation_sets_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_sets_get) | **GET** /validation-sets | Queries available validation sets based on the provided filter, paging and sorting criteria. *VolumeDiscountApi* | [**billing_period_billing_period_id_volume_discounts_get**](rapidata/api_client/docs/VolumeDiscountApi.md#billing_period_billing_period_id_volume_discounts_get) | **GET** /billing-period/{billingPeriodId}/volume-discounts | Gets all volume discount brackets for a billing period. *VolumeDiscountApi* | [**billing_period_billing_period_id_volume_discounts_post**](rapidata/api_client/docs/VolumeDiscountApi.md#billing_period_billing_period_id_volume_discounts_post) | **POST** /billing-period/{billingPeriodId}/volume-discounts | Creates a volume discount bracket for a billing period. -*WorkflowApi* | [**workflow_workflow_id_delete**](rapidata/api_client/docs/WorkflowApi.md#workflow_workflow_id_delete) | **DELETE** /workflow/{workflowId} | Deletes a workflow by its id. -*WorkflowApi* | [**workflow_workflow_id_progress_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_workflow_id_progress_get) | **GET** /workflow/{workflowId}/progress | Gets the progress of a workflow. -*WorkflowApi* | [**workflows_get**](rapidata/api_client/docs/WorkflowApi.md#workflows_get) | **GET** /workflows | Queries workflows based on the provided filter, page, and sort criteria. ## Documentation For Models @@ -466,7 +460,6 @@ Class | Method | HTTP request | Description - [AggregatorType](rapidata/api_client/docs/AggregatorType.md) - [AttachCategoryRapidBlueprintCategory](rapidata/api_client/docs/AttachCategoryRapidBlueprintCategory.md) - [AttachCategoryRapidCategory](rapidata/api_client/docs/AttachCategoryRapidCategory.md) - - [AttachCategoryWorkflowRapidBlueprintCategory](rapidata/api_client/docs/AttachCategoryWorkflowRapidBlueprintCategory.md) - [AudienceAudienceIdJobsGetJobIdParameter](rapidata/api_client/docs/AudienceAudienceIdJobsGetJobIdParameter.md) - [AudienceBoost](rapidata/api_client/docs/AudienceBoost.md) - [AudienceBoost2](rapidata/api_client/docs/AudienceBoost2.md) @@ -671,7 +664,6 @@ Class | Method | HTTP request | Description - [GetCombinedLeaderboardMatrixEndpointOutput](rapidata/api_client/docs/GetCombinedLeaderboardMatrixEndpointOutput.md) - [GetCombinedLeaderboardStandingsEndpointOutput](rapidata/api_client/docs/GetCombinedLeaderboardStandingsEndpointOutput.md) - [GetCombinedLeaderboardStandingsEndpointOutputItem](rapidata/api_client/docs/GetCombinedLeaderboardStandingsEndpointOutputItem.md) - - [GetCompareAbSummaryEndpointOutput](rapidata/api_client/docs/GetCompareAbSummaryEndpointOutput.md) - [GetCompatibleValidationSetsEndpointOutput](rapidata/api_client/docs/GetCompatibleValidationSetsEndpointOutput.md) - [GetCompatibleValidationSetsEndpointValidationSetOutput](rapidata/api_client/docs/GetCompatibleValidationSetsEndpointValidationSetOutput.md) - [GetCompletionTimeHistogramEndpointOutput](rapidata/api_client/docs/GetCompletionTimeHistogramEndpointOutput.md) @@ -692,8 +684,6 @@ Class | Method | HTTP request | Description - [GetFlowItemCreationTimeseriesEndpointOutputDataPoint](rapidata/api_client/docs/GetFlowItemCreationTimeseriesEndpointOutputDataPoint.md) - [GetGlobalResponsesEndpointOutput](rapidata/api_client/docs/GetGlobalResponsesEndpointOutput.md) - [GetGlobalResponsesEndpointOutputResponse](rapidata/api_client/docs/GetGlobalResponsesEndpointOutputResponse.md) - - [GetGroupedRankingWorkflowResultsEndpointOutput](rapidata/api_client/docs/GetGroupedRankingWorkflowResultsEndpointOutput.md) - - [GetGroupedRankingWorkflowResultsEndpointPagedResultOfOutput](rapidata/api_client/docs/GetGroupedRankingWorkflowResultsEndpointPagedResultOfOutput.md) - [GetInvoiceEndpointOutput](rapidata/api_client/docs/GetInvoiceEndpointOutput.md) - [GetJobAbSummaryEndpointOutput](rapidata/api_client/docs/GetJobAbSummaryEndpointOutput.md) - [GetJobByIdEndpointOutput](rapidata/api_client/docs/GetJobByIdEndpointOutput.md) @@ -715,7 +705,6 @@ Class | Method | HTTP request | Description - [GetOrganizationEndpointOutput](rapidata/api_client/docs/GetOrganizationEndpointOutput.md) - [GetOrganizationOwnerTierEndpointOutput](rapidata/api_client/docs/GetOrganizationOwnerTierEndpointOutput.md) - [GetParticipantByIdEndpointOutput](rapidata/api_client/docs/GetParticipantByIdEndpointOutput.md) - - [GetPipelineByIdEndpointOutput](rapidata/api_client/docs/GetPipelineByIdEndpointOutput.md) - [GetPlatformRelationMembersEndpointCursorPagedResultOfOutput](rapidata/api_client/docs/GetPlatformRelationMembersEndpointCursorPagedResultOfOutput.md) - [GetPlatformRelationMembersEndpointOutput](rapidata/api_client/docs/GetPlatformRelationMembersEndpointOutput.md) - [GetPromptEmbeddingMapEndpointOutput](rapidata/api_client/docs/GetPromptEmbeddingMapEndpointOutput.md) @@ -728,8 +717,6 @@ Class | Method | HTTP request | Description - [GetRankingFlowItemResultsEndpointOutput](rapidata/api_client/docs/GetRankingFlowItemResultsEndpointOutput.md) - [GetRankingFlowItemResultsEndpointOutputDatapoint](rapidata/api_client/docs/GetRankingFlowItemResultsEndpointOutputDatapoint.md) - [GetRankingFlowItemVoteMatrixEndpointOutput](rapidata/api_client/docs/GetRankingFlowItemVoteMatrixEndpointOutput.md) - - [GetRankingWorkflowResultsEndpointDatapoint](rapidata/api_client/docs/GetRankingWorkflowResultsEndpointDatapoint.md) - - [GetRankingWorkflowResultsEndpointOutput](rapidata/api_client/docs/GetRankingWorkflowResultsEndpointOutput.md) - [GetRapidNavigationEndpointCard](rapidata/api_client/docs/GetRapidNavigationEndpointCard.md) - [GetRapidNavigationEndpointCardResponse](rapidata/api_client/docs/GetRapidNavigationEndpointCardResponse.md) - [GetRapidNavigationEndpointItem](rapidata/api_client/docs/GetRapidNavigationEndpointItem.md) @@ -760,22 +747,12 @@ Class | Method | HTTP request | Description - [GetSamplesByParticipantEndpointPagedResultOfISampleOutput](rapidata/api_client/docs/GetSamplesByParticipantEndpointPagedResultOfISampleOutput.md) - [GetSignalByIdEndpointOutput](rapidata/api_client/docs/GetSignalByIdEndpointOutput.md) - [GetSignalRunByIdEndpointOutput](rapidata/api_client/docs/GetSignalRunByIdEndpointOutput.md) - - [GetSimpleWorkflowResultsEndpointOutput](rapidata/api_client/docs/GetSimpleWorkflowResultsEndpointOutput.md) - - [GetSimpleWorkflowResultsEndpointPagedResultOfOutput](rapidata/api_client/docs/GetSimpleWorkflowResultsEndpointPagedResultOfOutput.md) - - [GetSimpleWorkflowResultsEndpointResponseOutput](rapidata/api_client/docs/GetSimpleWorkflowResultsEndpointResponseOutput.md) - [GetUserScoreCacheEndpointOutput](rapidata/api_client/docs/GetUserScoreCacheEndpointOutput.md) - [GetValidationRapidsEndpointOutput](rapidata/api_client/docs/GetValidationRapidsEndpointOutput.md) - [GetValidationRapidsEndpointPagedResultOfOutput](rapidata/api_client/docs/GetValidationRapidsEndpointPagedResultOfOutput.md) - [GetValidationSetByIdEndpointOutput](rapidata/api_client/docs/GetValidationSetByIdEndpointOutput.md) - [GetVolumeDiscountsEndpointOutput](rapidata/api_client/docs/GetVolumeDiscountsEndpointOutput.md) - [GetVolumeDiscountsEndpointOutputVolumeDiscountItem](rapidata/api_client/docs/GetVolumeDiscountsEndpointOutputVolumeDiscountItem.md) - - [GetWorkflowByIdEndpointOutput](rapidata/api_client/docs/GetWorkflowByIdEndpointOutput.md) - - [GetWorkflowProgressEndpointOutput](rapidata/api_client/docs/GetWorkflowProgressEndpointOutput.md) - - [GetWorkflowResponsesEndpointOutput](rapidata/api_client/docs/GetWorkflowResponsesEndpointOutput.md) - - [GetWorkflowResponsesEndpointResponse](rapidata/api_client/docs/GetWorkflowResponsesEndpointResponse.md) - - [GetWorkflowResultsEndpointOutput](rapidata/api_client/docs/GetWorkflowResultsEndpointOutput.md) - - [GetWorkflowResultsEndpointPagedResultOfOutput](rapidata/api_client/docs/GetWorkflowResultsEndpointPagedResultOfOutput.md) - - [GetWorkflowResultsEndpointResponseOutput](rapidata/api_client/docs/GetWorkflowResultsEndpointResponseOutput.md) - [GoogleOneTapLoginEndpointInput](rapidata/api_client/docs/GoogleOneTapLoginEndpointInput.md) - [GoogleOneTapLoginEndpointOutput](rapidata/api_client/docs/GoogleOneTapLoginEndpointOutput.md) - [GrantBidderRelationEndpointInput](rapidata/api_client/docs/GrantBidderRelationEndpointInput.md) @@ -786,12 +763,6 @@ Class | Method | HTTP request | Description - [GroupedRankingGroup](rapidata/api_client/docs/GroupedRankingGroup.md) - [HuggingFaceSyncOutcome](rapidata/api_client/docs/HuggingFaceSyncOutcome.md) - [HuggingFaceSyncStatus](rapidata/api_client/docs/HuggingFaceSyncStatus.md) - - [IArtifact](rapidata/api_client/docs/IArtifact.md) - - [IArtifactCampaignArtifact](rapidata/api_client/docs/IArtifactCampaignArtifact.md) - - [IArtifactDatasetArtifact](rapidata/api_client/docs/IArtifactDatasetArtifact.md) - - [IArtifactFileArtifact](rapidata/api_client/docs/IArtifactFileArtifact.md) - - [IArtifactWorkflowArtifact](rapidata/api_client/docs/IArtifactWorkflowArtifact.md) - - [IArtifactWorkflowConfigArtifact](rapidata/api_client/docs/IArtifactWorkflowConfigArtifact.md) - [IAsset](rapidata/api_client/docs/IAsset.md) - [IAssetFileAsset](rapidata/api_client/docs/IAssetFileAsset.md) - [IAssetInput](rapidata/api_client/docs/IAssetInput.md) @@ -907,29 +878,7 @@ Class | Method | HTTP request | Description - [IPairMakerInformationFullPermutationPairMakerInformation](rapidata/api_client/docs/IPairMakerInformationFullPermutationPairMakerInformation.md) - [IPairMakerInformationOnlinePairMakerInformation](rapidata/api_client/docs/IPairMakerInformationOnlinePairMakerInformation.md) - [IPipelineArtifactCreateDatasetArtifact](rapidata/api_client/docs/IPipelineArtifactCreateDatasetArtifact.md) - - [IPipelineAsset](rapidata/api_client/docs/IPipelineAsset.md) - - [IPipelineAssetPipelineFileAsset](rapidata/api_client/docs/IPipelineAssetPipelineFileAsset.md) - - [IPipelineAssetPipelineMultiAsset](rapidata/api_client/docs/IPipelineAssetPipelineMultiAsset.md) - - [IPipelineAssetPipelineNullAsset](rapidata/api_client/docs/IPipelineAssetPipelineNullAsset.md) - - [IPipelineAssetPipelineTextAsset](rapidata/api_client/docs/IPipelineAssetPipelineTextAsset.md) - [IPipelineCreateSimplePipeline](rapidata/api_client/docs/IPipelineCreateSimplePipeline.md) - - [IPipelineMetadata](rapidata/api_client/docs/IPipelineMetadata.md) - - [IPipelineMetadataPipelineClassificationMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineClassificationMetadata.md) - - [IPipelineMetadataPipelineCountMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineCountMetadata.md) - - [IPipelineMetadataPipelineDurationMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineDurationMetadata.md) - - [IPipelineMetadataPipelineFileTypeMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineFileTypeMetadata.md) - - [IPipelineMetadataPipelineImageDimensionMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineImageDimensionMetadata.md) - - [IPipelineMetadataPipelineLocationMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineLocationMetadata.md) - - [IPipelineMetadataPipelineOriginalFilenameMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineOriginalFilenameMetadata.md) - - [IPipelineMetadataPipelineSourceUrlMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineSourceUrlMetadata.md) - - [IPipelineMetadataPipelineStreamsMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineStreamsMetadata.md) - - [IPipelineMetadataPipelineTextMetadata](rapidata/api_client/docs/IPipelineMetadataPipelineTextMetadata.md) - - [IPipelinePairMakerConfig](rapidata/api_client/docs/IPipelinePairMakerConfig.md) - - [IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig](rapidata/api_client/docs/IPipelinePairMakerConfigPipelineFullPermutationPairMakerConfig.md) - - [IPipelinePairMakerConfigPipelineOnlinePairMakerConfig](rapidata/api_client/docs/IPipelinePairMakerConfigPipelineOnlinePairMakerConfig.md) - - [IPipelineRankingConfig](rapidata/api_client/docs/IPipelineRankingConfig.md) - - [IPipelineRankingConfigPipelineBradleyTerryRankingConfig](rapidata/api_client/docs/IPipelineRankingConfigPipelineBradleyTerryRankingConfig.md) - - [IPipelineRankingConfigPipelineEloRankingConfig](rapidata/api_client/docs/IPipelineRankingConfigPipelineEloRankingConfig.md) - [IPipelineStep](rapidata/api_client/docs/IPipelineStep.md) - [IPipelineStepDatasetEvaluationStep](rapidata/api_client/docs/IPipelineStepDatasetEvaluationStep.md) - [IPipelineStepSendCompletionMailStep](rapidata/api_client/docs/IPipelineStepSendCompletionMailStep.md) @@ -1001,12 +950,6 @@ Class | Method | HTTP request | Description - [IRapidTranscriptionRapid](rapidata/api_client/docs/IRapidTranscriptionRapid.md) - [IReferee](rapidata/api_client/docs/IReferee.md) - [IRefereeBudgetReferee](rapidata/api_client/docs/IRefereeBudgetReferee.md) - - [IRefereeConfig](rapidata/api_client/docs/IRefereeConfig.md) - - [IRefereeConfigBudgetRefereeConfig](rapidata/api_client/docs/IRefereeConfigBudgetRefereeConfig.md) - - [IRefereeConfigNaiveRefereeConfig](rapidata/api_client/docs/IRefereeConfigNaiveRefereeConfig.md) - - [IRefereeConfigNeverEndingRefereeConfig](rapidata/api_client/docs/IRefereeConfigNeverEndingRefereeConfig.md) - - [IRefereeConfigProbabilisticAttachCategoryRefereeConfig](rapidata/api_client/docs/IRefereeConfigProbabilisticAttachCategoryRefereeConfig.md) - - [IRefereeConfigQuorumRefereeConfig](rapidata/api_client/docs/IRefereeConfigQuorumRefereeConfig.md) - [IRefereeEarlyStoppingReferee](rapidata/api_client/docs/IRefereeEarlyStoppingReferee.md) - [IRefereeInfo](rapidata/api_client/docs/IRefereeInfo.md) - [IRefereeInfoNaiveRefereeInfo](rapidata/api_client/docs/IRefereeInfoNaiveRefereeInfo.md) @@ -1056,27 +999,6 @@ Class | Method | HTTP request | Description - [IValidationTruthScrubTruth](rapidata/api_client/docs/IValidationTruthScrubTruth.md) - [IValidationTruthSkipTruth](rapidata/api_client/docs/IValidationTruthSkipTruth.md) - [IValidationTruthTranscriptionTruth](rapidata/api_client/docs/IValidationTruthTranscriptionTruth.md) - - [IWorkflow](rapidata/api_client/docs/IWorkflow.md) - - [IWorkflowConfig](rapidata/api_client/docs/IWorkflowConfig.md) - - [IWorkflowConfigEvaluationWorkflowConfig](rapidata/api_client/docs/IWorkflowConfigEvaluationWorkflowConfig.md) - - [IWorkflowConfigGroupedRankingWorkflowConfig](rapidata/api_client/docs/IWorkflowConfigGroupedRankingWorkflowConfig.md) - - [IWorkflowConfigRankingWorkflowConfig](rapidata/api_client/docs/IWorkflowConfigRankingWorkflowConfig.md) - - [IWorkflowConfigSimpleWorkflowConfig](rapidata/api_client/docs/IWorkflowConfigSimpleWorkflowConfig.md) - - [IWorkflowEvaluationWorkflow](rapidata/api_client/docs/IWorkflowEvaluationWorkflow.md) - - [IWorkflowGroupedRankingWorkflow](rapidata/api_client/docs/IWorkflowGroupedRankingWorkflow.md) - - [IWorkflowRankingWorkflow](rapidata/api_client/docs/IWorkflowRankingWorkflow.md) - - [IWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintAttachCategoryWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintBoundingBoxWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintCompareWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintFreeTextWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintLineWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintLineWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintLocateWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintNamedEntityWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintPolygonWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintScrubWorkflowRapidBlueprint.md) - - [IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint](rapidata/api_client/docs/IWorkflowRapidBlueprintTranscriptionWorkflowRapidBlueprint.md) - - [IWorkflowSimpleWorkflow](rapidata/api_client/docs/IWorkflowSimpleWorkflow.md) - [InspectReportEndpointOutput](rapidata/api_client/docs/InspectReportEndpointOutput.md) - [InviteOrgMemberEndpointInput](rapidata/api_client/docs/InviteOrgMemberEndpointInput.md) - [InviteOrgMemberEndpointOutput](rapidata/api_client/docs/InviteOrgMemberEndpointOutput.md) @@ -1109,7 +1031,6 @@ Class | Method | HTTP request | Description - [PagedResultOfIBillingGroup](rapidata/api_client/docs/PagedResultOfIBillingGroup.md) - [ParticipantStatus](rapidata/api_client/docs/ParticipantStatus.md) - [PidBatchMode](rapidata/api_client/docs/PidBatchMode.md) - - [PipelineEloRankingConfig](rapidata/api_client/docs/PipelineEloRankingConfig.md) - [PolygonResultCoordinate](rapidata/api_client/docs/PolygonResultCoordinate.md) - [PolygonResultShape](rapidata/api_client/docs/PolygonResultShape.md) - [PreviewOrderEndpointInput](rapidata/api_client/docs/PreviewOrderEndpointInput.md) @@ -1226,8 +1147,6 @@ Class | Method | HTTP request | Description - [QueryValidationSetsEndpointPagedResultOfOutput](rapidata/api_client/docs/QueryValidationSetsEndpointPagedResultOfOutput.md) - [QueryVouchersEndpointOutput](rapidata/api_client/docs/QueryVouchersEndpointOutput.md) - [QueryVouchersEndpointPagedResultOfOutput](rapidata/api_client/docs/QueryVouchersEndpointPagedResultOfOutput.md) - - [QueryWorkflowsEndpointOutput](rapidata/api_client/docs/QueryWorkflowsEndpointOutput.md) - - [QueryWorkflowsEndpointPagedResultOfOutput](rapidata/api_client/docs/QueryWorkflowsEndpointPagedResultOfOutput.md) - [RankingDatapoint](rapidata/api_client/docs/RankingDatapoint.md) - [RapidIssue](rapidata/api_client/docs/RapidIssue.md) - [RapidState](rapidata/api_client/docs/RapidState.md) @@ -1282,8 +1201,6 @@ Class | Method | HTTP request | Description - [StartBenchmarkHuggingFaceSyncEndpointOutput](rapidata/api_client/docs/StartBenchmarkHuggingFaceSyncEndpointOutput.md) - [StartBulkReconciliationEndpointInput](rapidata/api_client/docs/StartBulkReconciliationEndpointInput.md) - [StartBulkReconciliationEndpointOutput](rapidata/api_client/docs/StartBulkReconciliationEndpointOutput.md) - - [StartPreliminaryDownloadEndpointInput](rapidata/api_client/docs/StartPreliminaryDownloadEndpointInput.md) - - [StartPreliminaryDownloadEndpointOutput](rapidata/api_client/docs/StartPreliminaryDownloadEndpointOutput.md) - [StickyConfig](rapidata/api_client/docs/StickyConfig.md) - [StickyState](rapidata/api_client/docs/StickyState.md) - [SubmitFeedbackEndpointInput](rapidata/api_client/docs/SubmitFeedbackEndpointInput.md) @@ -1344,7 +1261,6 @@ Class | Method | HTTP request | Description - [VoucherSource](rapidata/api_client/docs/VoucherSource.md) - [VoucherStatus](rapidata/api_client/docs/VoucherStatus.md) - [WeightedBranch](rapidata/api_client/docs/WeightedBranch.md) - - [WorkflowState](rapidata/api_client/docs/WorkflowState.md) diff --git a/src/rapidata/rapidata_client/__init__.py b/src/rapidata/rapidata_client/__init__.py index a070ff069c..1e99048232 100644 --- a/src/rapidata/rapidata_client/__init__.py +++ b/src/rapidata/rapidata_client/__init__.py @@ -6,7 +6,6 @@ RapidataFilteredAudience, RecruitingMetrics, ) -from .order import RapidataOrderManager, RapidataOrder from .job import ( RapidataJob, RapidataJobDefinition, diff --git a/src/rapidata/rapidata_client/config/_qr_preview.py b/src/rapidata/rapidata_client/config/_qr_preview.py index e88ef3e869..a28bf17f26 100644 --- a/src/rapidata/rapidata_client/config/_qr_preview.py +++ b/src/rapidata/rapidata_client/config/_qr_preview.py @@ -1,37 +1,18 @@ from __future__ import annotations -"""Helpers for printing a terminal-friendly QR code that links to the public -campaign preview page. +"""Helper for printing a terminal-friendly link to the dashboard preview page. -The QR code is a convenience nudge so the user can open the preview on a phone -without copy-pasting the URL. All functions here are best-effort: failures are -logged at debug level and never raised to the caller, so order / job execution -is never affected by QR rendering problems. +Best-effort: a no-op in silent mode. Never raises to the caller, so job +creation is never affected by preview-link problems. """ -from time import sleep -from typing import TYPE_CHECKING, cast - -from rapidata.rapidata_client.config.logger import logger from rapidata.rapidata_client.config.managed_print import managed_print from rapidata.rapidata_client.config.rapidata_config import rapidata_config -if TYPE_CHECKING: - from rapidata.service.openapi_service import OpenAPIService - -_PREVIEW_URL_TEMPLATE = "https://rapids.{environment}/preview/campaign?id={campaign_id}" _APP_JOB_DEFINITION_URL_TEMPLATE = ( "https://app.{environment}/definitions/{job_definition_id}" ) -_APP_ORDER_URL_TEMPLATE = "https://app.{environment}/order/detail/{order_id}" - - -def build_campaign_preview_url(environment: str, campaign_id: str) -> str: - """Return the public preview URL for the given campaign.""" - return _PREVIEW_URL_TEMPLATE.format( - environment=environment, campaign_id=campaign_id - ) def build_job_definition_preview_url(environment: str, job_definition_id: str) -> str: @@ -41,167 +22,10 @@ def build_job_definition_preview_url(environment: str, job_definition_id: str) - ) -def build_order_preview_url(environment: str, order_id: str) -> str: - """Return the app URL for the given order's detail page.""" - return _APP_ORDER_URL_TEMPLATE.format(environment=environment, order_id=order_id) - - -def print_job_definition_preview_link( - environment: str, job_definition_id: str -) -> None: +def print_job_definition_preview_link(environment: str, job_definition_id: str) -> None: """Print the app URL for previewing the given job definition.""" if rapidata_config.logging.silent_mode: return url = build_job_definition_preview_url(environment, job_definition_id) managed_print(f"Preview in dashboard: {url}") - - -def print_order_preview_link(environment: str, order_id: str) -> None: - """Print the app URL for the given order's detail page.""" - if rapidata_config.logging.silent_mode: - return - - url = build_order_preview_url(environment, order_id) - managed_print(f"Preview in dashboard: {url}") - - -def print_campaign_preview_qr(environment: str, campaign_id: str) -> None: - """Print a terminal QR code that links to the campaign preview page. - - Respects ``rapidata_config.logging.silent_mode``. If QR rendering fails for - any reason we still surface the preview URL via ``managed_print`` so the - user can open it manually. - - Args: - environment: The Rapidata environment (e.g. ``rapidata.ai``). - campaign_id: The id of the campaign to preview. For orders this is the - order's campaign id; for job definitions it's the preview - (distilling) campaign id. - """ - if rapidata_config.logging.silent_mode: - return - - url = build_campaign_preview_url(environment, campaign_id) - - try: - import qrcode - from qrcode.constants import ERROR_CORRECT_L - - qr = qrcode.QRCode( - error_correction=ERROR_CORRECT_L, - border=1, - box_size=1, - ) - qr.add_data(url) - qr.make(fit=True) - - managed_print(f"Preview:") - qr.print_ascii(invert=True) - except Exception: - logger.warning( - "Failed to render preview QR code for %s", - url, - exc_info=True, - ) - managed_print(f"Preview at: {url}") - - -def _resolve_campaign_id_from_pipeline( - openapi_service: "OpenAPIService", - pipeline_id: str, - max_retries: int = 3, - retry_delay: float = 0.5, -) -> str | None: - """Pull the campaign id out of a pipeline's ``campaign-artifact``. - - Pipeline artifacts are populated asynchronously after creation, so we - retry a few times before giving up. Returns ``None`` if the artifact never - materialises. - - All API calls inside are wrapped in ``suppress_rapidata_error_logging`` so - retries and final failures stay at DEBUG level — this is a best-effort - convenience feature and should never surface noise to the user. - """ - from rapidata.api_client.models.campaign_artifact_model import ( - CampaignArtifactModel, - ) - from rapidata.rapidata_client.api.rapidata_api_client import ( - suppress_rapidata_error_logging, - ) - - for attempt in range(max_retries): - try: - with suppress_rapidata_error_logging(): - pipeline = ( - openapi_service.pipeline.pipeline_api.pipeline_pipeline_id_get( - pipeline_id - ) - ) - artifact = pipeline.artifacts.get("campaign-artifact") - if artifact is not None: - return cast( - CampaignArtifactModel, artifact.actual_instance - ).campaign_id - except Exception as e: - logger.debug( - "Pipeline '%s' campaign lookup attempt %d/%d failed: %s", - pipeline_id, - attempt + 1, - max_retries, - e, - ) - - if attempt < max_retries - 1: - sleep(retry_delay) - - logger.debug( - "Could not resolve campaign id from pipeline '%s' after %d attempts", - pipeline_id, - max_retries, - ) - return None - - -def print_campaign_preview_qr_for_pipeline( - openapi_service: "OpenAPIService", pipeline_id: str -) -> None: - """Fetch the campaign id from the given pipeline and print a preview QR code. - - Best-effort: the underlying API lookup is wrapped in - ``suppress_rapidata_error_logging`` so transient errors (including the - pipeline's campaign artifact not yet being populated) stay at DEBUG level, - and any remaining exception is swallowed with a debug log so callers never - need to guard this call. Also a no-op in silent mode. - - Args: - openapi_service: The OpenAPI service used to look up the pipeline. - pipeline_id: The id of the pipeline whose ``campaign-artifact`` should - be used for the preview. - """ - if rapidata_config.logging.silent_mode: - return - - try: - campaign_id = _resolve_campaign_id_from_pipeline(openapi_service, pipeline_id) - except Exception as e: - logger.debug( - "Campaign preview QR lookup for pipeline '%s' failed: %s", - pipeline_id, - e, - ) - return - - if not campaign_id: - return - - try: - print_campaign_preview_qr( - environment=openapi_service.environment, campaign_id=campaign_id - ) - except Exception as e: - logger.debug( - "Campaign preview QR render for pipeline '%s' failed: %s", - pipeline_id, - e, - ) diff --git a/src/rapidata/rapidata_client/exceptions/failed_upload_exception.py b/src/rapidata/rapidata_client/exceptions/failed_upload_exception.py index 49f9f3c9ea..f5c07427e5 100644 --- a/src/rapidata/rapidata_client/exceptions/failed_upload_exception.py +++ b/src/rapidata/rapidata_client/exceptions/failed_upload_exception.py @@ -13,22 +13,19 @@ from rapidata.rapidata_client.job._job_creation_state_machine import ( JobDefinitionCreationMachine, ) - from rapidata.rapidata_client.order.rapidata_order import RapidataOrder class FailedUploadException(Exception): - """Custom error class for Failed Uploads to the Rapidata order.""" + """Custom error class for failed datapoint uploads during job-definition creation.""" def __init__( self, dataset: RapidataDataset, failed_uploads: list[FailedUpload[Datapoint]], - order: Optional[RapidataOrder] = None, job_definition: Optional[RapidataJobDefinition] = None, machine: Optional[JobDefinitionCreationMachine] = None, ): self.dataset = dataset - self.order = order self.job_definition = job_definition self._failed_uploads = failed_uploads self._machine = machine @@ -59,8 +56,8 @@ def retry(self) -> RapidataJobDefinition: @property def machine(self) -> Optional[JobDefinitionCreationMachine]: - """The creation state machine backing ``retry()``, when this failure - came from job-definition creation (``None`` for order uploads).""" + """The creation state machine backing ``retry()`` for job-definition + creation.""" return self._machine @property @@ -177,8 +174,6 @@ def __str__(self) -> str: "dataset (no new dataset is created) by catching this exception and calling: " "\n\tjob_definition = exception.retry()" ) - if self.order: - failed_upload_message += f"\n\nTo run the order without the failed datapoints, call: \n\trapidata_client.order.get_order_by_id('{self.order.id}').run()" if self.job_definition: failed_upload_message += f"\n\nTo run the job definition without the failed datapoints, call: \n\taudience.assign_job(rapidata_client.job.get_job_definition_by_id('{self.job_definition.id}'))" diff --git a/src/rapidata/rapidata_client/job/_job_creation_state_machine.py b/src/rapidata/rapidata_client/job/_job_creation_state_machine.py index 8cedae108c..f467b7fa87 100644 --- a/src/rapidata/rapidata_client/job/_job_creation_state_machine.py +++ b/src/rapidata/rapidata_client/job/_job_creation_state_machine.py @@ -5,7 +5,6 @@ from rapidata.rapidata_client.config import logger, tracer from rapidata.rapidata_client.config._qr_preview import ( - print_campaign_preview_qr_for_pipeline, print_job_definition_preview_link, ) from rapidata.rapidata_client.dataset._rapidata_dataset import RapidataDataset @@ -197,10 +196,6 @@ def _persist_definition(self) -> None: openapi_service=self._openapi_service, ) - print_campaign_preview_qr_for_pipeline( - openapi_service=self._openapi_service, - pipeline_id=response.pipeline_id, - ) print_job_definition_preview_link( environment=self._openapi_service.environment, job_definition_id=self.job_definition.id, diff --git a/src/rapidata/rapidata_client/order/__init__.py b/src/rapidata/rapidata_client/order/__init__.py deleted file mode 100644 index 1b65f2a126..0000000000 --- a/src/rapidata/rapidata_client/order/__init__.py +++ /dev/null @@ -1,2 +0,0 @@ -from .rapidata_order_manager import RapidataOrderManager -from .rapidata_order import RapidataOrder diff --git a/src/rapidata/rapidata_client/order/_rapidata_order_builder.py b/src/rapidata/rapidata_client/order/_rapidata_order_builder.py deleted file mode 100644 index 38003b76f6..0000000000 --- a/src/rapidata/rapidata_client/order/_rapidata_order_builder.py +++ /dev/null @@ -1,365 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Optional, Sequence -import secrets - -from rapidata.rapidata_client.datapoints._datapoint import Datapoint - -if TYPE_CHECKING: - from rapidata.api_client.models.create_order import CreateOrder - from rapidata.api_client.models.sticky_config import StickyConfig -from rapidata.rapidata_client.exceptions.failed_upload_exception import ( - FailedUploadException, -) -from rapidata.rapidata_client.filter import RapidataFilter -from rapidata.rapidata_client.config import ( - logger, - managed_print, - tracer, -) -from rapidata.rapidata_client.config._qr_preview import ( - print_campaign_preview_qr_for_pipeline, - print_order_preview_link, -) -from rapidata.rapidata_client.validation.validation_set_manager import ( - ValidationSetManager, -) -from rapidata.rapidata_client.validation.rapidata_validation_set import ( - RapidataValidationSet, -) -from rapidata.rapidata_client.dataset._rapidata_dataset import RapidataDataset -from rapidata.rapidata_client.order.rapidata_order import RapidataOrder -from rapidata.rapidata_client.referee import Referee -from rapidata.rapidata_client.referee._naive_referee import NaiveReferee -from rapidata.rapidata_client.selection._base_selection import RapidataSelection -from rapidata.rapidata_client.settings import RapidataSetting -from rapidata.rapidata_client.workflow import Workflow -from rapidata.service.openapi_service import OpenAPIService - - -class RapidataOrderBuilder: - """Builder object for creating Rapidata orders. - - Use the fluent interface to set the desired configuration. Add a workflow to the order using `.workflow()` and finally call `.create()` to create the order. - - Args: - openapi_service (OpenAPIService): The OpenAPIService instance. - name (str): The name of the order. - """ - - def __init__( - self, - name: str, - openapi_service: OpenAPIService, - ): - self._name = name - self._openapi_service = openapi_service - self._dataset: Optional[RapidataDataset] = None - self._workflow: Workflow | None = None - self._referee: Referee | None = None - self._validation_set: RapidataValidationSet | None = None - self._settings: Sequence[RapidataSetting] | None = None - self._user_filters: list[RapidataFilter] = [] - self._selections: Sequence[RapidataSelection] = [] - self._priority: int | None = None - self._datapoints: list[Datapoint] = [] - self._sticky_config: StickyConfig | None = None - self._validation_set_manager: ValidationSetManager = ValidationSetManager( - self._openapi_service - ) - - def _to_model(self) -> CreateOrder: - """ - Convert the builder configuration to a CreateOrder. - - Raises: - ValueError: If no workflow is provided. - - Returns: - CreateOrder: The model representing the order configuration. - """ - if self._workflow is None: - raise ValueError("You must provide a workflow to create an order.") - - if self._referee is None: - managed_print("No referee provided, using default NaiveReferee.") - self._referee = NaiveReferee() - - validation_set_id = ( - self._validation_set.id - if (self._validation_set and not self._selections) - else None - ) - from rapidata.api_client.models.create_order import CreateOrder - - rapid_feature_flags = ( - [ - setting._to_feature_flag() - for setting in self._settings - if setting.target == "rapids" - ] - if self._settings is not None - else None - ) - campaign_feature_flags = ( - [ - setting._to_feature_flag() - for setting in self._settings - if setting.target == "campaign" - ] - if self._settings is not None - else None - ) - - return CreateOrder( - orderName=self._name, - workflow=self._workflow._to_model(), - userFilters=[user_filter._to_model() for user_filter in self._user_filters], - referee=self._referee._to_model(), - validationSetId=validation_set_id, - rapidFeatureFlags=rapid_feature_flags if rapid_feature_flags else None, - campaignFeatureFlags=( - campaign_feature_flags if campaign_feature_flags else None - ), - selections=( - [selection._to_model() for selection in self._selections] - if self._selections - else None - ), - priority=self._priority, - stickyConfig=self._sticky_config, - ) - - def _generate_id(self, length=9): - """Optimal balance: fast comparisons + low collision risk""" - alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" - return "".join(secrets.choice(alphabet) for _ in range(length)) - - def _create(self) -> RapidataOrder: - """ - Create the Rapidata order by making the necessary API calls based on the builder's configuration. - - Raises: - ValueError: If both media paths and texts are provided, or if neither is provided. - AssertionError: If the workflow is a CompareWorkflow and media paths are not in pairs. - - Returns: - RapidataOrder: The created RapidataOrder instance. - """ - order_model = self._to_model() - logger.debug("Creating order with model: %s", order_model) - - result = self._openapi_service.order.order_api.order_post( - create_order=order_model - ) - - order = RapidataOrder( - order_id=str(result.order_id), - openapi_service=self._openapi_service, - name=self._name, - ) - logger.debug("Order created: %s", order) - - if not result.dataset_id: - logger.error("No Dataset was created for order %s", order.id) - return order - - self._dataset = RapidataDataset(result.dataset_id, self._openapi_service) - - logger.debug("Dataset created with ID: %s", self._dataset.id) - logger.debug("Adding datapoints to the order.") - with tracer.start_as_current_span("add_datapoints"): - _, failed_uploads = self._dataset.add_datapoints(self._datapoints) - - if failed_uploads: - raise FailedUploadException(self._dataset, failed_uploads, order=order) - - logger.debug("Datapoints added to the order.") - logger.debug("Setting order to preview") - try: - self._openapi_service.order.order_api.order_order_id_preview_post(order.id) - except Exception as e: - logger.error("Failed to set order to preview: %s", e) - - # The campaign is materialised once the order enters preview, so the - # campaign artifact only shows up on the pipeline a moment later — let - # the helper poll for it. - print_campaign_preview_qr_for_pipeline( - openapi_service=self._openapi_service, - pipeline_id=result.pipeline_id, - ) - print_order_preview_link( - environment=self._openapi_service.environment, - order_id=order.id, - ) - return order - - def _set_workflow(self, workflow: Workflow) -> RapidataOrderBuilder: - """ - Set the workflow for the order. - - Args: - workflow (Workflow): The workflow to be set. - - Returns: - RapidataOrderBuilder: The updated RapidataOrderBuilder instance. - """ - if not isinstance(workflow, Workflow): - raise TypeError("Workflow must be of type Workflow.") - - self._workflow = workflow - return self - - def _set_referee(self, referee: Referee) -> "RapidataOrderBuilder": - """ - Set the referee for the order. - - Args: - referee (Referee): The referee to be set. - - Returns: - RapidataOrderBuilder: The updated RapidataOrderBuilder instance. - """ - if not isinstance(referee, Referee): - raise TypeError("Referee must be of type Referee.") - - self._referee = referee - return self - - def _set_datapoints( - self, - datapoints: list[Datapoint], - ) -> RapidataOrderBuilder: - """ - Set the datapoints for the order. - - Args: - datapoints: (Sequence[Datapoint]): The datapoints to be set. - - Returns: - RapidataOrderBuilder: The updated RapidataOrderBuilder instance. - """ - if not isinstance(datapoints, list): - raise TypeError( - "Datapoints must be provided as a list of Datapoint objects." - ) - - self._datapoints = datapoints - return self - - def _set_settings( - self, settings: Sequence[RapidataSetting] - ) -> RapidataOrderBuilder: - """ - Set the settings for the order. - - Args: - settings (Settings): The settings to be set. - - Returns: - RapidataOrderBuilder: The updated RapidataOrderBuilder instance. - """ - - if not isinstance(settings, list): - raise TypeError("Settings must be provided as a list of Setting objects.") - - for s in settings: - if not isinstance(s, RapidataSetting): - raise TypeError("The settings list must only contain Setting objects.") - - self._settings = settings - return self - - def _set_filters(self, filters: Sequence[RapidataFilter]) -> RapidataOrderBuilder: - """ - Set the filters for the order, e.g., country, language, userscore, etc. - - Args: - filters (Sequence[Filters]): The user filters to be set. - - Returns: - RapidataOrderBuilder: The updated RapidataOrderBuilder instance. - """ - if not isinstance(filters, list): - raise TypeError("Filters must be provided as a list of Filter objects.") - - for f in filters: - if not isinstance(f, RapidataFilter): - raise TypeError("Filters must be of type Filter.") - - if len(self._user_filters) > 0: - managed_print("Overwriting existing user filters.") - - self._user_filters = filters - return self - - def _set_validation_set_id( - self, validation_set_id: str | None = None - ) -> RapidataOrderBuilder: - """ - Set the validation set ID for the order. - - Args: - validation_set_id (str): The validation set ID to be set. - - Returns: - RapidataOrderBuilder: The updated RapidataOrderBuilder instance. - """ - if validation_set_id is not None and not isinstance(validation_set_id, str): - raise TypeError("Validation set ID must be of type str.") - if validation_set_id is not None: - self._validation_set = ( - self._validation_set_manager.get_validation_set_by_id(validation_set_id) - ) - return self - self._validation_set = validation_set_id - return self - - def _set_selections( - self, selections: Sequence[RapidataSelection] - ) -> RapidataOrderBuilder: - """ - Set the selections for the order. - - Args: - selections (Sequence[Selection]): The selections to be set. - - Returns: - RapidataOrderBuilder: The updated RapidataOrderBuilder instance. - """ - if not isinstance(selections, list): - raise TypeError( - "Selections must be provided as a list of Selection objects." - ) - - for selection in selections: - if not isinstance(selection, RapidataSelection): - raise TypeError("Selections must be of type Selection.") - - self._selections = selections # type: ignore - return self - - def _set_priority(self, priority: int | None = None) -> RapidataOrderBuilder: - """ - Set the priority for the order. - - Args: - priority (int): The priority to be set. - - Returns: - RapidataOrderBuilder: The updated RapidataOrderBuilder instance. - """ - if priority is not None and not isinstance(priority, int): - raise TypeError("Priority must be of type int.") - - self._priority = priority - return self - - def _set_sticky_config( - self, sticky_config: StickyConfig | None = None - ) -> RapidataOrderBuilder: - """ - Set the sticky behavior for the order. - """ - self._sticky_config = sticky_config - return self diff --git a/src/rapidata/rapidata_client/order/rapidata_order.py b/src/rapidata/rapidata_client/order/rapidata_order.py deleted file mode 100644 index 8112fee7f1..0000000000 --- a/src/rapidata/rapidata_client/order/rapidata_order.py +++ /dev/null @@ -1,512 +0,0 @@ -from __future__ import annotations - - -# Standard library imports -import json -import urllib.parse -import webbrowser -from time import sleep -from typing import cast, Callable, TypeVar, TYPE_CHECKING -from colorama import Fore -from datetime import datetime -from tqdm.auto import tqdm - -# Local/application imports -from rapidata.service.openapi_service import OpenAPIService -from rapidata.rapidata_client.config import ( - logger, - managed_print, - rapidata_config, - tracer, -) -from rapidata.rapidata_client.api.rapidata_api_client import ( - suppress_rapidata_error_logging, -) - -if TYPE_CHECKING: - from rapidata.api_client.models.campaign_artifact_model import CampaignArtifactModel - from rapidata.api_client.models.file_stream_result import FileStreamResult - from rapidata.api_client.models.order_state import OrderState - from rapidata.api_client.models.workflow_artifact_model import WorkflowArtifactModel - from rapidata.api_client.models.get_workflow_progress_endpoint_output import ( - GetWorkflowProgressEndpointOutput, - ) - from rapidata.rapidata_client.results.rapidata_results import RapidataResults - -T = TypeVar("T") - - -class RapidataOrder: - """ - An instance of a Rapidata order. - - Used to interact with a specific order in the Rapidata system, such as starting, - pausing, and retrieving results. - - Args: - name: The name of the order. - order_id: The ID of the order. - openapi_service: The OpenAPIService instance for API interaction. - """ - - def __init__( - self, - name: str, - order_id: str, - openapi_service: OpenAPIService, - ): - self.id = order_id - self.name = name - self.__created_at: datetime | None = None - self._openapi_service = openapi_service - self.__workflow_id: str = "" - self.__campaign_id: str = "" - self.__pipeline_id: str = "" - self.order_details_page = ( - f"https://app.{self._openapi_service.environment}/order/detail/{self.id}" - ) - logger.debug("RapidataOrder initialized") - - def _get_order_failure_message(self) -> str | None: - """Retrieves the failure message from the order if available.""" - try: - order = self._openapi_service.order.order_api.order_order_id_get(self.id) - return order.failure_message - except Exception: - logger.debug("Failed to get order failure message", self, exc_info=True) - return None - - def _retry_operation( - self, - operation: Callable[[], T], - max_retries: int = 10, - retry_delay: float = 2, - ) -> T: - """ - Unified retry logic for all operations with failure message handling. - - Args: - operation: The operation to retry - max_retries: Maximum number of retry attempts - retry_delay: Delay between retries in seconds - - Returns: - The result of the operation - - Raises: - Exception: If the operation fails after all retries, includes order failure message if available - """ - last_exception = None - - for attempt in range(max_retries): - try: - return operation() - except Exception as e: - last_exception = e - if attempt < max_retries - 1: - sleep(retry_delay) - - failure_message = self._get_order_failure_message() - if failure_message: - raise Exception(failure_message) from last_exception - - raise Exception( - f"Operation failed after {max_retries} retries: {str(last_exception)}" - ) from last_exception - - def _wait_for_state( - self, - target_states: list[OrderState], - check_interval: float = 5, - status_message: str | None = None, - ) -> str: - """ - Wait until the order reaches one of the target states. - - Args: - target_states: List of states to wait for - check_interval: How often to check the state in seconds - status_message: Optional message to display while waiting - - Returns: - The final state reached - """ - while (current_state := self.get_status()) not in target_states: - if status_message: - logger.debug(status_message, self, current_state) - sleep(check_interval) - - return current_state - - @property - def created_at(self) -> datetime: - """Returns the creation date of the order.""" - if not self.__created_at: - self.__created_at = ( - self._openapi_service.order.order_api.order_order_id_get( - self.id - ).order_date - ) - return self.__created_at - - def __get_pipeline_id(self) -> str: - """Gets the pipeline ID for this order (cached, internal use only).""" - if not self.__pipeline_id: - self.__pipeline_id = self._retry_operation( - lambda: self._openapi_service.order.order_api.order_order_id_get( - self.id - ).pipeline_id, - ) - return self.__pipeline_id - - def __get_workflow_id(self) -> str: - """Gets the workflow ID for this order (cached, internal use only).""" - if not self.__workflow_id: - self.__load_workflow_and_campaign_ids() - return self.__workflow_id - - def __get_campaign_id(self) -> str: - """Gets the campaign ID for this order (cached, internal use only).""" - if not self.__campaign_id: - self.__load_workflow_and_campaign_ids() - return self.__campaign_id - - def __load_workflow_and_campaign_ids(self) -> None: - """Loads workflow and campaign IDs from the pipeline (with retry logic).""" - if self.__workflow_id and self.__campaign_id: - return - - def fetch_ids(): - from rapidata.api_client.models.workflow_artifact_model import ( - WorkflowArtifactModel, - ) - from rapidata.api_client.models.campaign_artifact_model import ( - CampaignArtifactModel, - ) - - pipeline_id = self.__get_pipeline_id() - pipeline = ( - self._openapi_service.pipeline.pipeline_api.pipeline_pipeline_id_get( - pipeline_id - ) - ) - self.__workflow_id = cast( - WorkflowArtifactModel, - pipeline.artifacts["workflow-artifact"].actual_instance, - ).workflow_id - self.__campaign_id = cast( - CampaignArtifactModel, - pipeline.artifacts["campaign-artifact"].actual_instance, - ).campaign_id - - self._retry_operation(fetch_ids) - - def __get_workflow_progress(self) -> GetWorkflowProgressEndpointOutput: - """Gets the workflow progress (internal use only).""" - - def get_progress(): - with suppress_rapidata_error_logging(): - workflow_id = self.__get_workflow_id() - return self._openapi_service.workflow.workflow_api.workflow_workflow_id_progress_get( - workflow_id - ) - - return self._retry_operation( - get_progress, - max_retries=5, - retry_delay=4, - ) - - def run(self, after: RapidataOrder | str | None = None) -> RapidataOrder: - """Runs the order to start collecting responses. - Args: - after: The order to set as the preceding order. So order will only start collecting responses after the preceding order is completed. - Can be a RapidataOrder instance, a string order ID, or None. - If None, the order will start collecting responses immediately. - Returns: - The order itself. - """ - with tracer.start_as_current_span("RapidataOrder.run"): - if after: - logger.info( - "Setting preceding order for order '%s' to '%s'", self, after - ) - from rapidata.api_client.models.update_order_endpoint_input import ( - UpdateOrderEndpointInput, - ) - - self._openapi_service.order.order_api.order_order_id_patch( - self.id, - UpdateOrderEndpointInput( - precedingOrderId=( - after.id if isinstance(after, RapidataOrder) else after - ) - ), - ) - - logger.info("Starting order '%s'", self) - from rapidata.api_client.models.submit_order_endpoint_input import ( - SubmitOrderEndpointInput, - ) - - self._openapi_service.order.order_api.order_order_id_submit_post( - self.id, SubmitOrderEndpointInput(ignoreFailedDatapoints=True) - ) - logger.debug("Order '%s' has been started.", self) - managed_print( - f"Order '{self.name}' is now viewable under: {self.order_details_page}" - ) - return self - - def pause(self) -> None: - """Pauses the order.""" - with tracer.start_as_current_span("RapidataOrder.pause"): - logger.info("Pausing order '%s'", self) - self._openapi_service.order.order_api.order_order_id_pause_post(self.id) - logger.debug("Order '%s' has been paused.", self) - managed_print(f"Order '{self}' has been paused.") - - def unpause(self) -> None: - """Unpauses/resumes the order.""" - with tracer.start_as_current_span("RapidataOrder.unpause"): - logger.info("Unpausing order '%s'", self) - self._openapi_service.order.order_api.order_order_id_resume_post(self.id) - logger.debug("Order '%s' has been unpaused.", self) - managed_print(f"Order '{self}' has been unpaused.") - - def delete(self) -> None: - """Deletes the order.""" - with tracer.start_as_current_span("RapidataOrder.delete"): - logger.info("Deleting order '%s'", self) - self._openapi_service.order.order_api.order_order_id_delete(self.id) - logger.debug("Order '%s' has been deleted.", self) - managed_print(f"Order '{self}' has been deleted.") - - def get_status(self) -> str: - """ - Gets the status of the order. - - States: - Created: The order has been created but not started yet.\n - Preview: The order has been set up and ready but not collecting responses yet.\n - Submitted: The order has been submitted and is being reviewed.\n - ManualReview: The order is in manual review - something went wrong with the automatic approval.\n - Processing: The order is actively being processed.\n - Paused: The order has been paused.\n - Completed: The order has been completed.\n - Failed: The order has failed.\n - StaleResults: The order completed but its result file is no longer valid; calling get_results regenerates it automatically. - """ - with tracer.start_as_current_span("RapidataOrder.get_status"): - return self._openapi_service.order.order_api.order_order_id_get( - self.id - ).state - - def display_progress_bar(self, refresh_rate: int = 5) -> None: - """ - Displays a progress bar for the order processing using tqdm. - - Args: - refresh_rate: How often to refresh the progress bar, in seconds. - """ - from rapidata.api_client.models.order_state import OrderState - - if refresh_rate < 1: - raise ValueError("refresh_rate must be at least 1") - - if self.get_status() == OrderState.CREATED: - raise Exception("Order has not been started yet. Please start it first.") - - # Wait for submission review - while self.get_status() == OrderState.SUBMITTED: - managed_print( - f"Order '{self}' is submitted and being reviewed. Standby...", end="\r" - ) - sleep(1) - - if self.get_status() == OrderState.MANUALREVIEW: - raise Exception( - f"Order '{self}' is in manual review. It might take some time to start. " - f"To speed up the process, contact support (info@rapidata.ai).\n" - f"Once started, run this method again to display the progress bar." - ) - - # Terminal states that should break the progress-bar loop - # regardless of completion_percentage. Without this check a - # Failed or Paused order would pin the caller's thread forever. - terminal_states = { - OrderState.COMPLETED, - OrderState.PAUSED, - OrderState.FAILED, - OrderState.MANUALREVIEW, - } - - with tqdm( - total=100, - desc="Processing order", - unit="%", - bar_format="{desc}: {percentage:3.0f}%|{bar}| completed [{elapsed}<{remaining}, {rate_fmt}]", - disable=rapidata_config.logging.silent_mode, - ) as pbar: - last_percentage = 0 - while True: - current_percentage = ( - self.__get_workflow_progress().completion_percentage - ) - - if current_percentage > last_percentage: - pbar.update(current_percentage - last_percentage) - last_percentage = current_percentage - - if current_percentage >= 100: - break - - current_state = self.get_status() - if current_state in terminal_states: - logger.info( - "Progress bar exiting early: order is in state %s", - current_state, - ) - break - - sleep(refresh_rate) - - def _regenerate_results(self) -> None: - """Triggers regeneration of an order whose results have gone stale. - - A ``StaleResults`` order no longer has a valid/available result file; retrying it - re-runs the pipeline so a fresh result file is produced and the order completes - again. - """ - logger.info("Order '%s' has stale results, triggering regeneration", self) - managed_print( - f"Order '{self.name}' has stale results — regenerating, " - "this may take a few minutes..." - ) - self._openapi_service.order.order_api.order_order_id_retry_post(self.id) - - def get_results(self, preliminary_results: bool = False) -> RapidataResults: - """ - Gets the results of the order. - If the order is still processing, this method will block until the order is completed and then return the results. - If the order's results have gone stale, regeneration is triggered automatically and this method blocks until the fresh results are ready. - - Args: - preliminary_results: If True, returns the preliminary results of the order. Defaults to False. - Note that preliminary results are not final and may not contain all the datapoints & responses. Only the ones that are already available. - - Info: - Currently the SDK does not support streaming. The preliminary results are simply a snapshot of the results at the time of the request. - """ - with tracer.start_as_current_span("RapidataOrder.get_results"): - from rapidata.api_client.models.order_state import OrderState - from rapidata.api_client.exceptions import ApiException - from rapidata.rapidata_client.results.rapidata_results import ( - RapidataResults, - ) - - logger.info("Getting results for order '%s'...", self) - - if preliminary_results and self.get_status() not in [OrderState.COMPLETED]: - return self._get_preliminary_results() - - if preliminary_results and self.get_status() == OrderState.COMPLETED: - managed_print("Order is already completed. Returning final results.") - - # Stale results have no downloadable file until the pipeline is re-run; - # trigger that automatically before waiting for the re-completion. - if self.get_status() == OrderState.STALERESULTS: - self._regenerate_results() - - self._wait_for_state( - target_states=[ - OrderState.COMPLETED, - OrderState.PAUSED, - OrderState.MANUALREVIEW, - OrderState.FAILED, - ], - status_message="Order '%s' is in state %s, waiting for completion...", - ) - - try: - results = self._openapi_service.order.order_api.order_order_id_download_results_get( - order_id=self.id - ) - return RapidataResults(json.loads(results)) - except (ApiException, json.JSONDecodeError) as e: - raise Exception(f"Failed to get order results: {str(e)}") from e - - def _get_preliminary_results(self) -> RapidataResults: - """Fetches preliminary results for an in-progress order.""" - from rapidata.api_client.models.start_preliminary_download_endpoint_input import ( - StartPreliminaryDownloadEndpointInput, - ) - from rapidata.api_client.exceptions import ApiException - from rapidata.rapidata_client.results.rapidata_results import RapidataResults - - try: - pipeline_id = self.__get_pipeline_id() - download_id = self._openapi_service.pipeline.pipeline_api.pipeline_pipeline_id_preliminary_download_post( - pipeline_id, StartPreliminaryDownloadEndpointInput(sendEmail=False) - ).download_id - - def check_results(): - results = self._openapi_service.pipeline.pipeline_api.pipeline_preliminary_download_preliminary_download_id_get( - preliminary_download_id=download_id - ) - return RapidataResults(json.loads(results)) - - return self._retry_operation( - check_results, - max_retries=60, - retry_delay=1, - ) - - except (ApiException, json.JSONDecodeError) as e: - raise Exception(f"Failed to get preliminary results: {str(e)}") from e - - def view(self) -> None: - """Opens the order details page in the browser.""" - logger.info("Opening order details page in browser...") - if not webbrowser.open(self.order_details_page): - encoded_url = urllib.parse.quote( - self.order_details_page, safe="%/:=&?~#+!$,;'@()*[]" - ) - managed_print( - Fore.RED - + f"Please open this URL in your browser: '{encoded_url}'" - + Fore.RESET - ) - - def preview(self) -> None: - """Opens a preview of the order in the browser.""" - from rapidata.api_client.models.order_state import OrderState - from rapidata.api_client.models.preview_order_endpoint_input import ( - PreviewOrderEndpointInput, - ) - - logger.info("Opening order preview in browser...") - - if self.get_status() == OrderState.CREATED: - logger.info("Order is still in state created. Setting it to preview.") - self._openapi_service.order.order_api.order_order_id_preview_post( - self.id, PreviewOrderEndpointInput(ignoreFailedDatapoints=True) - ) - logger.info("Order is now in preview state.") - - campaign_id = self.__get_campaign_id() - auth_url = f"https://app.{self._openapi_service.environment}/order/detail/{self.id}/preview?campaignId={campaign_id}" - - if not webbrowser.open(auth_url): - encoded_url = urllib.parse.quote(auth_url, safe="%/:=&?~#+!$,;'@()*[]") - managed_print( - Fore.RED - + f"Please open this URL in your browser: '{encoded_url}'" - + Fore.RESET - ) - - def __str__(self) -> str: - return f"RapidataOrder(name='{self.name}', order_id='{self.id}')" - - def __repr__(self) -> str: - return f"RapidataOrder(name='{self.name}', order_id='{self.id}')" diff --git a/src/rapidata/rapidata_client/order/rapidata_order_manager.py b/src/rapidata/rapidata_client/order/rapidata_order_manager.py deleted file mode 100644 index efae4c828d..0000000000 --- a/src/rapidata/rapidata_client/order/rapidata_order_manager.py +++ /dev/null @@ -1,958 +0,0 @@ -from __future__ import annotations - -import warnings -from typing import Literal, Optional, Sequence, TYPE_CHECKING - -from opentelemetry import trace - -from rapidata.rapidata_client.config import logger -from rapidata.rapidata_client.config.tracer import tracer -from rapidata.rapidata_client.datapoints._datapoint import Datapoint -from rapidata.rapidata_client.datapoints._datapoints_validator import ( - DatapointsValidator, -) -from rapidata.rapidata_client.filter import RapidataFilter -from rapidata.rapidata_client.filter.rapidata_filters import RapidataFilters -from rapidata.rapidata_client.settings import RapidataSetting, RapidataSettings -from rapidata.rapidata_client.selection.rapidata_selections import RapidataSelections -from rapidata.rapidata_client.context.context_manager import ContextManager -from rapidata.service.openapi_service import OpenAPIService - -if TYPE_CHECKING: - from rapidata.api_client.models.sticky_config import StickyConfig - from rapidata.rapidata_client.order.rapidata_order import RapidataOrder - from rapidata.rapidata_client.selection._base_selection import RapidataSelection - from rapidata.rapidata_client.workflow import ( - Workflow, - ) - - -_ORDER_DEPRECATION_MESSAGE = ( - "client.order is deprecated and will be removed in a future release. " - "Use client.job to create job definitions and client.audience to assign them " - "instead. See https://docs.rapidata.ai/." -) - - -class RapidataOrderManager: - """ - Handels everything regarding the orders from creation to retrieval. - - Deprecated: - ``client.order`` is deprecated and will be removed in a future release. - Use ``client.job`` to create job definitions and ``client.audience`` to - assign them instead. See https://docs.rapidata.ai/ for the migration guide. - - Attributes: - filters (RapidataFilters): The RapidataFilters instance. - settings (RapidataSettings): The RapidataSettings instance. - selections (RapidataSelections): The RapidataSelections instance.""" - - def __init__(self, openapi_service: OpenAPIService): - self.__openapi_service = openapi_service - self.__context_manager = ContextManager(openapi_service) - self.filters = RapidataFilters - self.settings = RapidataSettings - self.selections = RapidataSelections - - self.__priority: int | None = None - self.__sticky_config: StickyConfig | None = None - self.__deprecation_warned = False - logger.debug("RapidataOrderManager initialized") - - def _warn_deprecated(self) -> None: - # Warn once per manager instance so loops creating many orders don't spam. - if self.__deprecation_warned: - return - self.__deprecation_warned = True - warnings.warn(_ORDER_DEPRECATION_MESSAGE, DeprecationWarning, stacklevel=3) - logger.warning(_ORDER_DEPRECATION_MESSAGE) - - def _create_general_order( - self, - name: str, - workflow: Workflow, - datapoints: list[Datapoint], - responses_per_datapoint: int = 10, - validation_set_id: str | None = None, - confidence_threshold: float | None = None, - quorum_threshold: int | None = None, - filters: Sequence[RapidataFilter] | None = None, - settings: Sequence[RapidataSetting] | None = None, - selections: Sequence[RapidataSelection] | None = None, - ) -> RapidataOrder: - self._warn_deprecated() - self.__context_manager._apply_context_shortening( - datapoints=datapoints, - question=workflow._get_instruction(), - ) - if filters is None: - filters = [] - if settings is None: - settings = [] - if selections is None: - selections = [] - - if confidence_threshold is not None and quorum_threshold is not None: - raise ValueError( - "Cannot set both confidence_threshold and quorum_threshold. Choose one stopping strategy." - ) - - if confidence_threshold is None and quorum_threshold is None: - from rapidata.rapidata_client.referee._naive_referee import NaiveReferee - - referee = NaiveReferee(responses=responses_per_datapoint) - elif quorum_threshold is not None: - from rapidata.rapidata_client.referee._quorum_referee import QuorumReferee - - referee = QuorumReferee( - threshold=quorum_threshold, - max_votes=responses_per_datapoint, - ) - else: - from rapidata.rapidata_client.referee._early_stopping_referee import ( - EarlyStoppingReferee, - ) - - assert confidence_threshold is not None - referee = EarlyStoppingReferee( - threshold=confidence_threshold, - max_responses=responses_per_datapoint, - ) - - logger.debug( - "Creating order with parameters: name %s, workflow %s, datapoints %s, responses_per_datapoint %s, validation_set_id %s, confidence_threshold %s, filters %s, settings %s, selections %s", - name, - workflow, - len(datapoints), - responses_per_datapoint, - validation_set_id, - confidence_threshold, - filters, - settings, - selections, - ) - - from rapidata.rapidata_client.order._rapidata_order_builder import ( - RapidataOrderBuilder, - ) - - order_builder = RapidataOrderBuilder( - name=name, openapi_service=self.__openapi_service - ) - - if selections and validation_set_id: - logger.warning( - "Warning: Both selections and validation_set_id provided. Ignoring validation_set_id." - ) - - def create_order() -> RapidataOrder: - return ( - order_builder._set_workflow(workflow) - ._set_datapoints(datapoints=datapoints) - ._set_referee(referee) - ._set_filters(filters) - ._set_selections(selections) - ._set_settings(settings) - ._set_validation_set_id(validation_set_id if not selections else None) - ._set_priority(self.__priority) - ._set_sticky_config(self.__sticky_config) - ._create() - ) - - # Only create a new trace if there isn't already an active one - current_span = trace.get_current_span() - if current_span.is_recording(): - order = create_order() - else: - with tracer.start_as_current_span("create_order"): - order = create_order() - - logger.debug("Order created: %s", order) - return order - - def _set_priority(self, priority: int | None): - if priority is not None and not isinstance(priority, int): - raise TypeError("Priority must be an integer or None") - - if priority is not None and priority < 0: - raise ValueError("Priority must be a positive integer or None") - - self.__priority = priority - - def _set_sticky_config(self, sticky_config: StickyConfig | None): - self.__sticky_config = sticky_config - - def create_classification_order( - self, - name: str, - instruction: str, - answer_options: list[str], - datapoints: list[str], - data_type: Literal["media", "text"] = "media", - responses_per_datapoint: int = 10, - contexts: list[str] | None = None, - media_contexts: list[list[str]] | None = None, - validation_set_id: str | None = None, - confidence_threshold: float | None = None, - quorum_threshold: int | None = None, - filters: Sequence[RapidataFilter] | None = None, - settings: Sequence[RapidataSetting] | None = None, - selections: Sequence[RapidataSelection] | None = None, - private_metadata: list[dict[str, str]] | None = None, - ) -> RapidataOrder: - """Create a classification order. - - With this order you can have a datapoint (image, text, video, audio) be classified into one of the answer options. - Each response will be exactly one of the answer options. - - Args: - name (str): The name of the order. (Will not be shown to the labeler) - instruction (str): The instruction for how the data should be classified. - answer_options (list[str]): The list of options for the classification. - datapoints (list[str]): The list of datapoints for the classification - each datapoint will be labeled. - data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n - Other option: "text". - responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10. - contexts (list[str], optional): The list of contexts for the classification. Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction and options. (Therefore will be different for each datapoint) - Will be match up with the datapoints using the list index. - media_contexts (list[list[str]], optional): The list of image URLs / paths shown for the classification (each inner list is the images shown for that datapoint). Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction and options. (Therefore will be different for each datapoint) - Use a single-element inner list for one image per datapoint, or multiple entries to display several images. - validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n - If provided, one validation task will be shown infront of the datapoints that will be labeled. - confidence_threshold (float, optional): The probability threshold for the classification. Defaults to None.\n - If provided, the classification datapoint will stop after the threshold is reached or at the number of responses, whatever happens first. - quorum_threshold (int, optional): The number of matching responses required to reach quorum. Defaults to None.\n - If provided, the classification datapoint will stop when this many responses agree or that quorum can't be reached anymore or after responses_per_datapoint votes. - Cannot be used together with confidence_threshold. - filters (Sequence[RapidataFilter], optional): The list of filters for the classification. Defaults to []. Decides who the tasks should be shown to. - settings (Sequence[RapidataSetting], optional): The list of settings for the classification. Defaults to []. Decides how the tasks should be shown. - selections (Sequence[RapidataSelection], optional): The list of selections for the classification. Defaults to []. Decides in what order the tasks should be shown. - private_metadata (list[dict[str, str]], optional): Key-value string pairs for each datapoint. Defaults to None. - If provided has to be the same length as datapoints.\n - This will NOT be shown to the labelers but will be included in the result purely for your own reference. - - Example: - ```python - from rapidata import RapidataClient, NoShuffleSetting - - rapi = RapidataClient() - order = rapi.order.create_classification_order( - name="Image Quality Rating", - instruction="How would you rate the quality of this image?", - answer_options=["1: Poor", "2: Fair", "3: Good", "4: Excellent"], - datapoints=["https://example.com/image1.jpg", "https://example.com/image2.jpg"], - responses_per_datapoint=15, - settings=[NoShuffleSetting()], # Keep options in order for Likert scale - ).run() - - results = order.get_results() - ``` - """ - with tracer.start_as_current_span( - "RapidataOrderManager.create_classification_order" - ): - if not isinstance(datapoints, list) or not all( - isinstance(datapoint, str) for datapoint in datapoints - ): - raise ValueError("Datapoints must be a list of strings") - - from rapidata.rapidata_client.workflow import ClassifyWorkflow - - datapoints_instances = DatapointsValidator.map_datapoints( - datapoints=datapoints, - contexts=contexts, - media_contexts=media_contexts, - private_metadata=private_metadata, - data_type=data_type, - ) - return self._create_general_order( - name=name, - workflow=ClassifyWorkflow( - instruction=instruction, answer_options=answer_options - ), - datapoints=datapoints_instances, - responses_per_datapoint=responses_per_datapoint, - validation_set_id=validation_set_id, - confidence_threshold=confidence_threshold, - quorum_threshold=quorum_threshold, - filters=filters, - selections=selections, - settings=settings, - ) - - def create_compare_order( - self, - name: str, - instruction: str, - datapoints: list[list[str]], - data_type: Literal["media", "text"] = "media", - responses_per_datapoint: int = 10, - contexts: list[str] | None = None, - media_contexts: list[list[str]] | None = None, - a_b_names: list[str] | None = None, - validation_set_id: str | None = None, - confidence_threshold: float | None = None, - quorum_threshold: int | None = None, - filters: Sequence[RapidataFilter] | None = None, - settings: Sequence[RapidataSetting] | None = None, - selections: Sequence[RapidataSelection] | None = None, - private_metadata: list[dict[str, str]] | None = None, - ) -> RapidataOrder: - """Create a compare order. - - With this order you compare two datapoints (image, text, video, audio) and the annotators will choose one of the two based on the instruction. - - Args: - name (str): The name of the order. (Will not be shown to the labeler) - instruction (str): The instruction for the comparison. Will be shown along side each datapoint. - datapoints (list[list[str]]): Outher list is the datapoints, inner list is the options for the comparison - each datapoint will be labeled. - data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n - Other option: "text". - responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10. - contexts (list[str], optional): The list of contexts for the comparison. Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Will be matched up with the datapoints using the list index. - media_contexts (list[list[str]], optional): The list of image URLs / paths shown for the comparison (each inner list is the images shown for that datapoint). Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Will be matched up with the datapoints using the list index. - Use a single-element inner list for one image per datapoint, or multiple entries to display several images. - a_b_names (list[str], optional): Custom naming for the two opposing models defined by the index in the datapoints list. Defaults to None.\n - If provided has to be a list of exactly two strings. - example: - ```python - datapoints = [["path_to_image_A", "path_to_image_B"], ["path_to_text_A", "path_to_text_B"]] - a_b_naming = ["Model A", "Model B"] - ``` - The results will then correctly show "Model A" and "Model B". - If not provided, the results will be shown as "A" and "B". - validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n - If provided, one validation task will be shown infront of the datapoints that will be labeled. - confidence_threshold (float, optional): The probability threshold for the comparison. Defaults to None.\n - If provided, the comparison datapoint will stop after the threshold is reached or at the number of responses, whatever happens first. - quorum_threshold (int, optional): The number of matching responses required to reach quorum. Defaults to None.\n - If provided, the comparison datapoint will stop when this many responses agree or that quorum can't be reached anymore or after responses_per_datapoint votes. - Cannot be used together with confidence_threshold. - Example: - ```python - responses_per_datapoint = 10 - quorum_threshold = 7 - ``` - This will stop at 7 responses for one side or if both sides have at least 4 responses. - filters (Sequence[RapidataFilter], optional): The list of filters for the comparison. Defaults to []. Decides who the tasks should be shown to. - settings (Sequence[RapidataSetting], optional): The list of settings for the comparison. Defaults to []. Decides how the tasks should be shown. - selections (Sequence[RapidataSelection], optional): The list of selections for the comparison. Defaults to []. Decides in what order the tasks should be shown. - private_metadata (list[dict[str, str]], optional): Key-value string pairs for each datapoint. Defaults to None.\n - If provided has to be the same length as datapoints.\n - This will NOT be shown to the labelers but will be included in the result purely for your own reference. - - Example: - ```python - from rapidata import RapidataClient - - rapi = RapidataClient() - order = rapi.order.create_compare_order( - name="Image Prompt Alignment", - instruction="Which image follows the prompt more accurately?", - datapoints=[ - ["https://example.com/model_a_img1.jpg", "https://example.com/model_b_img1.jpg"], - ["https://example.com/model_a_img2.jpg", "https://example.com/model_b_img2.jpg"], - ], - contexts=["A cat sitting on a red couch", "A blue car in the rain"], - responses_per_datapoint=25, - a_b_names=["Flux", "Midjourney"], # Optional: label the models in results - ).run() - - results = order.get_results() - ``` - """ - with tracer.start_as_current_span("RapidataOrderManager.create_compare_order"): - if any(not isinstance(datapoint, list) for datapoint in datapoints): - raise ValueError("Each datapoint must be a list of 2 paths/texts") - - if any(len(set(datapoint)) != 2 for datapoint in datapoints): - raise ValueError( - "Each datapoint must contain exactly two unique options" - ) - - if a_b_names is not None and len(a_b_names) != 2: - raise ValueError( - "A_B_naming must be a list of exactly two strings or None" - ) - - from rapidata.rapidata_client.workflow import CompareWorkflow - - datapoints_instances = DatapointsValidator.map_datapoints( - datapoints=datapoints, - contexts=contexts, - media_contexts=media_contexts, - private_metadata=private_metadata, - data_type=data_type, - multi_asset=True, - ) - return self._create_general_order( - name=name, - workflow=CompareWorkflow(instruction=instruction, a_b_names=a_b_names), - datapoints=datapoints_instances, - responses_per_datapoint=responses_per_datapoint, - validation_set_id=validation_set_id, - confidence_threshold=confidence_threshold, - quorum_threshold=quorum_threshold, - filters=filters, - selections=selections, - settings=settings, - ) - - def create_ranking_order( - self, - name: str, - instruction: str, - datapoints: list[list[str]], - comparison_budget_per_ranking: int, - responses_per_comparison: int = 1, - data_type: Literal["media", "text"] = "media", - random_comparisons_ratio: float = 0.5, - contexts: Optional[list[str]] = None, - media_contexts: Optional[list[list[str]]] = None, - validation_set_id: Optional[str] = None, - filters: Sequence[RapidataFilter] | None = None, - settings: Sequence[RapidataSetting] | None = None, - selections: Sequence[RapidataSelection] | None = None, - ) -> RapidataOrder: - """ - Create a ranking order. - - With this order you can have a multiple lists of datapoints (image, text, video, audio) be ranked based on the instruction. - Each list will be ranked independently, based on comparison matchups. - - Args: - name (str): The name of the order. - instruction (str): The instruction for the ranking. Will be shown with each matchup. - datapoints (list[list[str]]): The outer list is determines the independent rankings, the inner list is the datapoints for each ranking. - comparison_budget_per_ranking (int): The number of comparisons that will be collected per ranking (outer list of datapoints).\n - Rankings with more than 10 datapoints are matched adaptively (Elo-style) within this budget. - Rankings with 10 or fewer datapoints compare every unique pair, spreading the budget evenly across the pairs — - the total is rounded down to a multiple of the number of pairs, and is at least one comparison per pair. - responses_per_comparison (int, optional): The number of responses that will be collected per comparison. Defaults to 1. - data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n - Other option: "text". - random_comparisons_ratio (float, optional): The ratio of random comparisons to the total number of comparisons. Defaults to 0.5.\n - Only applies to rankings with more than 10 datapoints; smaller rankings compare every unique pair. - contexts (list[str], optional): The list of contexts for the ranking. Defaults to None.\n - If provided has to be the same length as the outer list of datapoints and will be shown in addition to the instruction. (Therefore will be different for each ranking) - Will be matched up with the datapoints using the list index. - media_contexts (list[list[str]], optional): The list of image URLs / paths shown for the ranking (each inner list is the images shown for that ranking). Defaults to None.\n - If provided has to be the same length as the outer list of datapoints and will be shown in addition to the instruction. (Therefore will be different for each ranking) - Will be matched up with the datapoints using the list index. - Use a single-element inner list for one image per ranking, or multiple entries to display several images. - validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n - If provided, one validation task will be shown infront of the datapoints that will be labeled. - filters (Sequence[RapidataFilter], optional): The list of filters for the ranking. Defaults to []. Decides who the tasks should be shown to. - settings (Sequence[RapidataSetting], optional): The list of settings for the ranking. Defaults to []. Decides how the tasks should be shown. - selections (Sequence[RapidataSelection], optional): The list of selections for the ranking. Defaults to []. Decides in what order the tasks should be shown. - - Example: - ```python - from rapidata import RapidataClient - - rapi = RapidataClient() - # Rank 12 images by preference using 50 pairwise comparisons - order = rapi.order.create_ranking_order( - name="Image Quality Ranking", - instruction="Which image looks better?", - datapoints=[["img1.jpg", "img2.jpg", "img3.jpg", "img4.jpg", "img5.jpg", - "img6.jpg", "img7.jpg", "img8.jpg", "img9.jpg", "img10.jpg", - "img11.jpg", "img12.jpg"]], - comparison_budget_per_ranking=50, - random_comparisons_ratio=0.5, # 50% random, 50% close matchups - ).run() - - results = order.get_results() # Returns ranked list with scores - ``` - """ - with tracer.start_as_current_span("RapidataOrderManager.create_ranking_order"): - if contexts and len(contexts) != len(datapoints): - raise ValueError( - "Number of contexts must match the number of sets that will be ranked" - ) - if media_contexts and len(media_contexts) != len(datapoints): - raise ValueError( - "Number of media contexts must match the number of sets that will be ranked" - ) - if not isinstance(datapoints, list) or not all( - isinstance(dp, list) for dp in datapoints - ): - raise ValueError( - "Datapoints must be a list of lists. Outer list is the independent rankings, inner list is the datapoints for each ranking." - ) - if not all(len(set(dp)) == len(dp) for dp in datapoints): - raise ValueError("Each inner list must contain unique datapoints.") - - if not all(len(inner_list) >= 2 for inner_list in datapoints): - raise ValueError( - "Each ranking must contain at least two unique datapoints." - ) - - from rapidata.rapidata_client.workflow import MultiRankingWorkflow - - datapoints_instances = [] - for i, datapoint in enumerate(datapoints): - for d in datapoint: - datapoints_instances.append( - Datapoint( - asset=d, - data_type=data_type, - context=contexts[i] if contexts else None, - media_context=media_contexts[i] if media_contexts else None, - group=str(i), - ) - ) - - workflow = MultiRankingWorkflow( - instruction=instruction, - comparison_budget_per_ranking=comparison_budget_per_ranking, - random_comparisons_ratio=random_comparisons_ratio, - max_group_size=max(len(group) for group in datapoints), - responses_per_comparison=responses_per_comparison, - ) - - return self._create_general_order( - name=name, - workflow=workflow, - datapoints=datapoints_instances, - responses_per_datapoint=workflow.responses_per_datapoint, - validation_set_id=validation_set_id, - filters=filters, - selections=selections, - settings=settings, - ) - - def create_free_text_order( - self, - name: str, - instruction: str, - datapoints: list[str], - data_type: Literal["media", "text"] = "media", - responses_per_datapoint: int = 10, - contexts: list[str] | None = None, - media_contexts: list[list[str]] | None = None, - filters: Sequence[RapidataFilter] | None = None, - settings: Sequence[RapidataSetting] | None = None, - selections: Sequence[RapidataSelection] | None = None, - private_metadata: list[dict[str, str]] | None = None, - ) -> RapidataOrder: - """Create a free text order. - - With this order you can have a datapoint (image, text, video, audio) be labeled with free text. - The annotators will be shown a datapoint and will be asked to answer a question with free text. - - Args: - name (str): The name of the order. - instruction (str): The instruction to answer with free text. Will be shown along side each datapoint. - datapoints (list[str]): The list of datapoints for the free text - each datapoint will be labeled. - data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n - Other option: "text". - responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10. - contexts (list[str], optional): The list of contexts for the free text. Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Will be matched up with the datapoints using the list index. - media_contexts (list[list[str]], optional): The list of image URLs / paths shown for the free text (each inner list is the images shown for that datapoint). Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Will be matched up with the datapoints using the list index. - Use a single-element inner list for one image per datapoint, or multiple entries to display several images. - filters (Sequence[RapidataFilter], optional): The list of filters for the free text. Defaults to []. Decides who the tasks should be shown to. - settings (Sequence[RapidataSetting], optional): The list of settings for the free text. Defaults to []. Decides how the tasks should be shown. - selections (Sequence[RapidataSelection], optional): The list of selections for the free text. Defaults to []. Decides in what order the tasks should be shown. - private_metadata (list[dict[str, str]], optional): Key-value string pairs for each datapoint. Defaults to None.\n - If provided has to be the same length as datapoints.\n - This will NOT be shown to the labelers but will be included in the result purely for your own reference. - - Example: - ```python - from rapidata import RapidataClient, FreeTextMinimumCharactersSetting - - rapi = RapidataClient() - order = rapi.order.create_free_text_order( - name="Image Captioning", - instruction="Describe what you see in this image in detail", - datapoints=["https://example.com/image1.jpg", "https://example.com/image2.jpg"], - responses_per_datapoint=5, - settings=[FreeTextMinimumCharactersSetting(20)], # Require at least 20 characters - ).run() - - results = order.get_results() - ``` - """ - with tracer.start_as_current_span( - "RapidataOrderManager.create_free_text_order" - ): - from rapidata.rapidata_client.workflow import FreeTextWorkflow - - datapoints_instances = DatapointsValidator.map_datapoints( - datapoints=datapoints, - contexts=contexts, - media_contexts=media_contexts, - private_metadata=private_metadata, - data_type=data_type, - ) - return self._create_general_order( - name=name, - workflow=FreeTextWorkflow(instruction=instruction), - datapoints=datapoints_instances, - responses_per_datapoint=responses_per_datapoint, - filters=filters, - selections=selections, - settings=settings, - ) - - def create_select_words_order( - self, - name: str, - instruction: str, - datapoints: list[str], - sentences: list[str], - responses_per_datapoint: int = 10, - media_contexts: list[list[str]] | None = None, - validation_set_id: str | None = None, - filters: Sequence[RapidataFilter] | None = None, - settings: Sequence[RapidataSetting] | None = None, - selections: Sequence[RapidataSelection] | None = None, - private_metadata: list[dict[str, str]] | None = None, - ) -> RapidataOrder: - """Create a select words order. - - With this order you can have a datapoint (image, text, video, audio) be labeled with a list of words. - The annotators will be shown a datapoint as well as a list of sentences split up by spaces. - They will then select specific words based on the instruction. - - Args: - name (str): The name of the order. - instruction (str): The instruction for how the words should be selected. Will be shown along side each datapoint. - datapoints (list[str]): The list of datapoints for the select words - each datapoint will be labeled. - sentences (list[str]): The list of sentences for the select words - Will be split up by spaces and shown along side each datapoint.\n - Must be the same length as datapoints. - responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10. - media_contexts (list[list[str]], optional): The list of image URLs / paths shown for the select words (each inner list is the images shown for that datapoint). Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Use a single-element inner list for one image per datapoint, or multiple entries to display several images. - validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n - If provided, one validation task will be shown infront of the datapoints that will be labeled. - filters (Sequence[RapidataFilter], optional): The list of filters for the select words. Defaults to []. Decides who the tasks should be shown to. - settings (Sequence[RapidataSetting], optional): The list of settings for the select words. Defaults to []. Decides how the tasks should be shown. - selections (Sequence[RapidataSelection], optional): The list of selections for the select words. Defaults to []. Decides in what order the tasks should be shown. - private_metadata (list[dict[str, str]], optional): Key-value string pairs for each datapoint. Defaults to None.\n - If provided has to be the same length as datapoints.\n - This will NOT be shown to the labelers but will be included in the result purely for your own reference. - - Example: - ```python - from rapidata import RapidataClient - - rapi = RapidataClient() - order = rapi.order.create_select_words_order( - name="Find Text-Image Mismatches", - instruction="Select words that don't match what's shown in the image", - datapoints=["https://example.com/image1.jpg", "https://example.com/image2.jpg"], - sentences=["A red car on a blue road", "Two cats playing with yarn"], - responses_per_datapoint=15, - ).run() - - results = order.get_results() - ``` - """ - with tracer.start_as_current_span( - "RapidataOrderManager.create_select_words_order" - ): - from rapidata.rapidata_client.workflow import SelectWordsWorkflow - - datapoints_instances = DatapointsValidator.map_datapoints( - datapoints=datapoints, - sentences=sentences, - media_contexts=media_contexts, - private_metadata=private_metadata, - ) - return self._create_general_order( - name=name, - workflow=SelectWordsWorkflow( - instruction=instruction, - ), - datapoints=datapoints_instances, - responses_per_datapoint=responses_per_datapoint, - validation_set_id=validation_set_id, - filters=filters, - selections=selections, - settings=settings, - ) - - def create_locate_order( - self, - name: str, - instruction: str, - datapoints: list[str], - responses_per_datapoint: int = 10, - contexts: list[str] | None = None, - media_contexts: list[list[str]] | None = None, - validation_set_id: str | None = None, - filters: Sequence[RapidataFilter] | None = None, - settings: Sequence[RapidataSetting] | None = None, - selections: Sequence[RapidataSelection] | None = None, - private_metadata: list[dict[str, str]] | None = None, - ) -> RapidataOrder: - """Create a locate order. - - With this order you can have people locate specific objects in a datapoint (image, text, video, audio). - The annotators will be shown a datapoint and will be asked to select locations based on the instruction. - - Args: - name (str): The name of the order. - instruction (str): The instruction what should be located. Will be shown along side each datapoint. - datapoints (list[str]): The list of datapoints for the locate - each datapoint will be labeled. - responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10. - contexts (list[str], optional): The list of contexts for the locate. Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Will be match up with the datapoints using the list index. - media_contexts (list[list[str]], optional): The list of image URLs / paths shown for the locate (each inner list is the images shown for that datapoint). Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Use a single-element inner list for one image per datapoint, or multiple entries to display several images. - validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n - If provided, one validation task will be shown infront of the datapoints that will be labeled. - filters (Sequence[RapidataFilter], optional): The list of filters for the locate. Defaults to []. Decides who the tasks should be shown to. - settings (Sequence[RapidataSetting], optional): The list of settings for the locate. Defaults to []. Decides how the tasks should be shown. - selections (Sequence[RapidataSelection], optional): The list of selections for the locate. Defaults to []. Decides in what order the tasks should be shown. - private_metadata (list[dict[str, str]], optional): Key-value string pairs for each datapoint. Defaults to None.\n - If provided has to be the same length as datapoints.\n - This will NOT be shown to the labelers but will be included in the result purely for your own reference. - - Example: - ```python - from rapidata import RapidataClient - - rapi = RapidataClient() - order = rapi.order.create_locate_order( - name="Find Artifacts", - instruction="Tap on any visual glitches or errors in the image", - datapoints=["https://example.com/ai_generated1.jpg", "https://example.com/ai_generated2.jpg"], - responses_per_datapoint=35, - ).run() - - results = order.get_results() - ``` - """ - with tracer.start_as_current_span("RapidataOrderManager.create_locate_order"): - from rapidata.rapidata_client.workflow import LocateWorkflow - - datapoints_instances = DatapointsValidator.map_datapoints( - datapoints=datapoints, - contexts=contexts, - media_contexts=media_contexts, - private_metadata=private_metadata, - ) - return self._create_general_order( - name=name, - workflow=LocateWorkflow(target=instruction), - datapoints=datapoints_instances, - responses_per_datapoint=responses_per_datapoint, - validation_set_id=validation_set_id, - filters=filters, - selections=selections, - settings=settings, - ) - - def create_draw_order( - self, - name: str, - instruction: str, - datapoints: list[str], - responses_per_datapoint: int = 10, - contexts: list[str] | None = None, - media_contexts: list[list[str]] | None = None, - validation_set_id: str | None = None, - filters: Sequence[RapidataFilter] | None = None, - settings: Sequence[RapidataSetting] | None = None, - selections: Sequence[RapidataSelection] | None = None, - private_metadata: list[dict[str, str]] | None = None, - ) -> RapidataOrder: - """Create a draw order. - - With this order you can have people draw lines on a datapoint (image, text, video, audio). - The annotators will be shown a datapoint and will be asked to draw lines based on the instruction. - - Args: - name (str): The name of the order. - instruction (str): The instruction for how the lines should be drawn. Will be shown along side each datapoint. - datapoints (list[str]): The list of datapoints for the draw lines - each datapoint will be labeled. - responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10. - contexts (list[str], optional): The list of contexts for the comparison. Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Will be match up with the datapoints using the list index. - media_contexts (list[list[str]], optional): The list of image URLs / paths shown for the draw lines (each inner list is the images shown for that datapoint). Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Use a single-element inner list for one image per datapoint, or multiple entries to display several images. - validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n - If provided, one validation task will be shown infront of the datapoints that will be labeled. - filters (Sequence[RapidataFilter], optional): The list of filters for the draw lines. Defaults to []. Decides who the tasks should be shown to. - settings (Sequence[RapidataSetting], optional): The list of settings for the draw lines. Defaults to []. Decides how the tasks should be shown. - selections (Sequence[RapidataSelection], optional): The list of selections for the draw lines. Defaults to []. Decides in what order the tasks should be shown. - private_metadata (list[dict[str, str]], optional): Key-value string pairs for each datapoint. Defaults to None.\n - If provided has to be the same length as datapoints.\n - This will NOT be shown to the labelers but will be included in the result purely for your own reference. - - Example: - ```python - from rapidata import RapidataClient - - rapi = RapidataClient() - order = rapi.order.create_draw_order( - name="Segment Objects", - instruction="Color in all the cars in the image", - datapoints=["https://example.com/street1.jpg", "https://example.com/street2.jpg"], - responses_per_datapoint=35, - ).run() - - results = order.get_results() - ``` - """ - with tracer.start_as_current_span("RapidataOrderManager.create_draw_order"): - from rapidata.rapidata_client.workflow import DrawWorkflow - - datapoints_instances = DatapointsValidator.map_datapoints( - datapoints=datapoints, - contexts=contexts, - media_contexts=media_contexts, - private_metadata=private_metadata, - ) - return self._create_general_order( - name=name, - workflow=DrawWorkflow(target=instruction), - datapoints=datapoints_instances, - responses_per_datapoint=responses_per_datapoint, - validation_set_id=validation_set_id, - filters=filters, - selections=selections, - settings=settings, - ) - - def create_timestamp_order( - self, - name: str, - instruction: str, - datapoints: list[str], - responses_per_datapoint: int = 10, - contexts: list[str] | None = None, - media_contexts: list[list[str]] | None = None, - validation_set_id: str | None = None, - filters: Sequence[RapidataFilter] | None = None, - settings: Sequence[RapidataSetting] | None = None, - selections: Sequence[RapidataSelection] | None = None, - private_metadata: list[dict[str, str]] | None = None, - ) -> RapidataOrder: - """Create a timestamp order. - - Warning: - This order is currently not fully supported and may give unexpected results. - - With this order you can have people mark specific timestamps in a datapoint (video, audio). - The annotators will be shown a datapoint and will be asked to select a timestamp based on the instruction. - - Args: - name (str): The name of the order. - instruction (str): The instruction for the timestamp task. Will be shown along side each datapoint. - datapoints (list[str]): The list of datapoints for the timestamp - each datapoint will be labeled. - responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10. - contexts (list[str], optional): The list of contexts for the comparison. Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Will be match up with the datapoints using the list index. - media_contexts (list[list[str]], optional): The list of image URLs / paths shown for the timestamp (each inner list is the images shown for that datapoint). Defaults to None.\n - If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint) - Use a single-element inner list for one image per datapoint, or multiple entries to display several images. - validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n - If provided, one validation task will be shown infront of the datapoints that will be labeled. - filters (Sequence[RapidataFilter], optional): The list of filters for the timestamp. Defaults to []. Decides who the tasks should be shown to. - settings (Sequence[RapidataSetting], optional): The list of settings for the timestamp. Defaults to []. Decides how the tasks should be shown. - selections (Sequence[RapidataSelection], optional): The list of selections for the timestamp. Defaults to []. Decides in what order the tasks should be shown. - private_metadata (list[dict[str, str]], optional): Key-value string pairs for each datapoint. Defaults to None.\n - If provided has to be the same length as datapoints.\n - This will NOT be shown to the labelers but will be included in the result purely for your own reference. - """ - - with tracer.start_as_current_span( - "RapidataOrderManager.create_timestamp_order" - ): - from rapidata.rapidata_client.workflow import TimestampWorkflow - - datapoints_instances = DatapointsValidator.map_datapoints( - datapoints=datapoints, - contexts=contexts, - media_contexts=media_contexts, - private_metadata=private_metadata, - ) - return self._create_general_order( - name=name, - workflow=TimestampWorkflow(instruction=instruction), - datapoints=datapoints_instances, - responses_per_datapoint=responses_per_datapoint, - validation_set_id=validation_set_id, - filters=filters, - selections=selections, - settings=settings, - ) - - def get_order_by_id(self, order_id: str) -> RapidataOrder: - """Get an order by ID. - - Args: - order_id (str): The ID of the order. - - Returns: - RapidataOrder: The Order instance. - """ - self._warn_deprecated() - with tracer.start_as_current_span("RapidataOrderManager.get_order_by_id"): - from rapidata.rapidata_client.order.rapidata_order import RapidataOrder - - order = self.__openapi_service.order.order_api.order_order_id_get(order_id) - - return RapidataOrder( - order_id=order_id, - name=order.order_name, - openapi_service=self.__openapi_service, - ) - - def find_orders( - self, name: str = "", amount: int = 10, page: int = 1 - ) -> list[RapidataOrder]: - """Find your recent orders given criteria. If nothing is provided, it will return the most recent order. - - Args: - name (str, optional): The name of the order - matching order will contain the name. Defaults to "" for any order. - amount (int, optional): The amount of orders to return. Defaults to 10. - page (int, optional): The page of orders to return. Defaults to 1. - - Returns: - list[RapidataOrder]: A list of RapidataOrder instances. - """ - self._warn_deprecated() - with tracer.start_as_current_span("RapidataOrderManager.find_orders"): - from rapidata.api_client.models.audience_audience_id_jobs_get_job_id_parameter import ( - AudienceAudienceIdJobsGetJobIdParameter, - ) - - order_page_result = self.__openapi_service.order.order_api.orders_get( - page=page, - page_size=amount, - order_name=AudienceAudienceIdJobsGetJobIdParameter(contains=name), - sort=["-order_date"], - ) - - orders = [ - self.get_order_by_id(order.id) for order in order_page_result.items - ] - return orders - - def __str__(self) -> str: - return "RapidataOrderManager" - - def __repr__(self) -> str: - return self.__str__() diff --git a/src/rapidata/rapidata_client/rapidata_client.py b/src/rapidata/rapidata_client/rapidata_client.py index 760fca7de7..cd468a6c12 100644 --- a/src/rapidata/rapidata_client/rapidata_client.py +++ b/src/rapidata/rapidata_client/rapidata_client.py @@ -19,7 +19,6 @@ from rapidata.rapidata_client.audience.rapidata_audience_manager import ( RapidataAudienceManager, ) -from rapidata.rapidata_client.order.rapidata_order_manager import RapidataOrderManager from rapidata.rapidata_client.validation.validation_set_manager import ( ValidationSetManager, ) @@ -68,7 +67,7 @@ class _UserInfoCacheEntry: class RapidataClient: - """The Rapidata client is the main entry point for interacting with the Rapidata API. It allows you to create orders and validation sets.""" + """The Rapidata client is the main entry point for interacting with the Rapidata API. It allows you to create jobs, audiences, and validation sets.""" def __init__( self, @@ -117,8 +116,6 @@ def __init__( leeway (int, optional): How many seconds before its actual expiry a token is treated as expired — i.e. how early it is refreshed (or re-read from ``token_file``). Defaults to 60 seconds. Attributes: - order (RapidataOrderManager): The RapidataOrderManager instance. - Deprecated: use ``job`` together with ``audience`` instead. validation (ValidationSetManager): The ValidationSetManager instance. flow (RapidataFlowManager): The RapidataFlowManager instance. audience (RapidataAudienceManager): The RapidataAudienceManager instance. @@ -174,9 +171,6 @@ def __init__( self._asset_uploader = AssetUploader(openapi_service=self._openapi_service) - logger.debug("Initializing RapidataOrderManager") - self.order = RapidataOrderManager(openapi_service=self._openapi_service) - logger.debug("Initializing ValidationSetManager") self.validation = ValidationSetManager( openapi_service=self._openapi_service diff --git a/src/rapidata/service/openapi_service.py b/src/rapidata/service/openapi_service.py index 658911a191..2ff8524ee8 100644 --- a/src/rapidata/service/openapi_service.py +++ b/src/rapidata/service/openapi_service.py @@ -19,8 +19,6 @@ from rapidata.service.services.validation_service import ValidationService from rapidata.service.services.dataset_service import DatasetService from rapidata.service.services.campaign_service import CampaignService - from rapidata.service.services.pipeline_service import PipelineService - from rapidata.service.services.workflow_service import WorkflowService from rapidata.service.services.leaderboard_service import LeaderboardService from rapidata.service.services.rapid_service import RapidService from rapidata.service.services.signal_service import SignalService @@ -76,8 +74,6 @@ def __init__( self._validation: ValidationService | None = None self._dataset: DatasetService | None = None self._campaign: CampaignService | None = None - self._pipeline: PipelineService | None = None - self._workflow: WorkflowService | None = None self._leaderboard: LeaderboardService | None = None self._rapid: RapidService | None = None self._signal: SignalService | None = None @@ -197,20 +193,6 @@ def campaign(self) -> CampaignService: self._campaign = CampaignService(self.api_client) return self._campaign - @property - def pipeline(self) -> PipelineService: - if self._pipeline is None: - from rapidata.service.services.pipeline_service import PipelineService - self._pipeline = PipelineService(self.api_client) - return self._pipeline - - @property - def workflow(self) -> WorkflowService: - if self._workflow is None: - from rapidata.service.services.workflow_service import WorkflowService - self._workflow = WorkflowService(self.api_client) - return self._workflow - @property def leaderboard(self) -> LeaderboardService: if self._leaderboard is None: diff --git a/src/rapidata/service/services/pipeline_service.py b/src/rapidata/service/services/pipeline_service.py deleted file mode 100644 index 03dbcb5116..0000000000 --- a/src/rapidata/service/services/pipeline_service.py +++ /dev/null @@ -1,20 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING - -if TYPE_CHECKING: - from rapidata.api_client.api.pipeline_api import PipelineApi - from rapidata.rapidata_client.api.rapidata_api_client import RapidataApiClient - - -class PipelineService: - def __init__(self, api_client: RapidataApiClient) -> None: - self._api_client = api_client - self._pipeline_api: PipelineApi | None = None - - @property - def pipeline_api(self) -> PipelineApi: - if self._pipeline_api is None: - from rapidata.api_client.api.pipeline_api import PipelineApi - self._pipeline_api = PipelineApi(self._api_client) - return self._pipeline_api diff --git a/src/rapidata/service/services/workflow_service.py b/src/rapidata/service/services/workflow_service.py deleted file mode 100644 index bc3facaca5..0000000000 --- a/src/rapidata/service/services/workflow_service.py +++ /dev/null @@ -1,20 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING - -if TYPE_CHECKING: - from rapidata.api_client.api.workflow_api import WorkflowApi - from rapidata.rapidata_client.api.rapidata_api_client import RapidataApiClient - - -class WorkflowService: - def __init__(self, api_client: RapidataApiClient) -> None: - self._api_client = api_client - self._workflow_api: WorkflowApi | None = None - - @property - def workflow_api(self) -> WorkflowApi: - if self._workflow_api is None: - from rapidata.api_client.api.workflow_api import WorkflowApi - self._workflow_api = WorkflowApi(self._api_client) - return self._workflow_api diff --git a/tests/rapidata_client/job/test_job_creation_state_machine.py b/tests/rapidata_client/job/test_job_creation_state_machine.py index 0057ab0951..fda126d6c8 100644 --- a/tests/rapidata_client/job/test_job_creation_state_machine.py +++ b/tests/rapidata_client/job/test_job_creation_state_machine.py @@ -59,7 +59,6 @@ def _run(svc, datapoints, tolerance, add_datapoints_side_effect): with ( patch(f"{MODULE}.RapidataDataset", return_value=dataset), - patch(f"{MODULE}.print_campaign_preview_qr_for_pipeline"), patch(f"{MODULE}.print_job_definition_preview_link"), patch(JOB_INPUT), ): @@ -111,7 +110,6 @@ def test_failure_exceeds_tolerance_raises_without_definition(): with ( patch(f"{MODULE}.RapidataDataset", return_value=dataset), - patch(f"{MODULE}.print_campaign_preview_qr_for_pipeline"), patch(f"{MODULE}.print_job_definition_preview_link"), patch(JOB_INPUT), ): @@ -144,7 +142,6 @@ def test_retry_reuses_dataset_and_persists_definition(): with ( patch(f"{MODULE}.RapidataDataset", return_value=dataset) as dataset_cls, - patch(f"{MODULE}.print_campaign_preview_qr_for_pipeline"), patch(f"{MODULE}.print_job_definition_preview_link"), patch(JOB_INPUT), ): @@ -184,7 +181,6 @@ def test_all_fail_never_creates_definition_even_at_full_tolerance(): with ( patch(f"{MODULE}.RapidataDataset", return_value=dataset), - patch(f"{MODULE}.print_campaign_preview_qr_for_pipeline"), patch(f"{MODULE}.print_job_definition_preview_link"), patch(JOB_INPUT), ):