capture-runtime-client 0.4.0__py3-none-any.whl

capture_runtime_client/private/schemas/capture-event-v2.schema.json

@@ -0,0 +1,301 @@
+{
+  "$defs": {
+    "CaptureFailureV2": {
+      "additionalProperties": false,
+      "properties": {
+        "code": {
+          "pattern": "^[a-z][a-z0-9_]{1,63}$",
+          "title": "Code",
+          "type": "string"
+        },
+        "message": {
+          "maxLength": 500,
+          "minLength": 1,
+          "title": "Message",
+          "type": "string"
+        },
+        "stage": {
+          "anyOf": [
+            {
+              "minLength": 1,
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Stage"
+        },
+        "retryable": {
+          "default": false,
+          "title": "Retryable",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "code",
+        "message"
+      ],
+      "title": "CaptureFailureV2",
+      "type": "object"
+    },
+    "CaptureSourceKind": {
+      "enum": [
+        "pdf",
+        "image",
+        "audio"
+      ],
+      "title": "CaptureSourceKind",
+      "type": "string"
+    },
+    "PageLocator": {
+      "additionalProperties": false,
+      "properties": {
+        "kind": {
+          "const": "page",
+          "default": "page",
+          "title": "Kind",
+          "type": "string"
+        },
+        "page": {
+          "minimum": 1,
+          "title": "Page",
+          "type": "integer"
+        },
+        "boundingBox": {
+          "anyOf": [
+            {
+              "maxItems": 4,
+              "minItems": 4,
+              "prefixItems": [
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "number"
+                }
+              ],
+              "type": "array"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Boundingbox"
+        }
+      },
+      "required": [
+        "page"
+      ],
+      "title": "PageLocator",
+      "type": "object"
+    },
+    "RawCaptureSegment": {
+      "additionalProperties": false,
+      "properties": {
+        "segmentId": {
+          "minLength": 1,
+          "title": "Segmentid",
+          "type": "string"
+        },
+        "order": {
+          "minimum": 0,
+          "title": "Order",
+          "type": "integer"
+        },
+        "locator": {
+          "discriminator": {
+            "mapping": {
+              "page": "#/$defs/PageLocator",
+              "time": "#/$defs/TimeLocator"
+            },
+            "propertyName": "kind"
+          },
+          "oneOf": [
+            {
+              "$ref": "#/$defs/PageLocator"
+            },
+            {
+              "$ref": "#/$defs/TimeLocator"
+            }
+          ],
+          "title": "Locator"
+        },
+        "text": {
+          "maxLength": 2000000,
+          "minLength": 1,
+          "title": "Text",
+          "type": "string"
+        }
+      },
+      "required": [
+        "segmentId",
+        "order",
+        "locator",
+        "text"
+      ],
+      "title": "RawCaptureSegment",
+      "type": "object"
+    },
+    "StreamingEventType": {
+      "enum": [
+        "accepted",
+        "input_checkpoint",
+        "heartbeat",
+        "segment",
+        "checkpoint",
+        "resync_required",
+        "completed",
+        "failed",
+        "cancelled"
+      ],
+      "title": "StreamingEventType",
+      "type": "string"
+    },
+    "TimeLocator": {
+      "additionalProperties": false,
+      "properties": {
+        "kind": {
+          "const": "time",
+          "default": "time",
+          "title": "Kind",
+          "type": "string"
+        },
+        "startMs": {
+          "minimum": 0,
+          "title": "Startms",
+          "type": "integer"
+        },
+        "endMs": {
+          "exclusiveMinimum": 0,
+          "title": "Endms",
+          "type": "integer"
+        }
+      },
+      "required": [
+        "startMs",
+        "endMs"
+      ],
+      "title": "TimeLocator",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "properties": {
+    "protocolVersion": {
+      "const": "2",
+      "default": "2",
+      "title": "Protocolversion",
+      "type": "string"
+    },
+    "eventId": {
+      "minLength": 1,
+      "title": "Eventid",
+      "type": "string"
+    },
+    "sequence": {
+      "minimum": 0,
+      "title": "Sequence",
+      "type": "integer"
+    },
+    "captureId": {
+      "minLength": 1,
+      "title": "Captureid",
+      "type": "string"
+    },
+    "kind": {
+      "$ref": "#/$defs/CaptureSourceKind",
+      "default": "audio"
+    },
+    "eventType": {
+      "$ref": "#/$defs/StreamingEventType"
+    },
+    "stage": {
+      "minLength": 1,
+      "title": "Stage",
+      "type": "string"
+    },
+    "progress": {
+      "anyOf": [
+        {
+          "maximum": 1,
+          "minimum": 0,
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "title": "Progress"
+    },
+    "partialRevision": {
+      "anyOf": [
+        {
+          "minimum": 0,
+          "type": "integer"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "title": "Partialrevision"
+    },
+    "coveredUntilMs": {
+      "anyOf": [
+        {
+          "minimum": 0,
+          "type": "integer"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "title": "Covereduntilms"
+    },
+    "segments": {
+      "items": {
+        "$ref": "#/$defs/RawCaptureSegment"
+      },
+      "maxItems": 1000,
+      "title": "Segments",
+      "type": "array"
+    },
+    "error": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/CaptureFailureV2"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null
+    },
+    "createdAt": {
+      "format": "date-time",
+      "title": "Createdat",
+      "type": "string"
+    }
+  },
+  "required": [
+    "eventId",
+    "sequence",
+    "captureId",
+    "eventType",
+    "stage",
+    "createdAt"
+  ],
+  "title": "CaptureEventV2",
+  "type": "object"
+}

capture_runtime_client/private/schemas/capture-failure-v2.schema.json

@@ -0,0 +1,40 @@
+{
+  "additionalProperties": false,
+  "properties": {
+    "code": {
+      "pattern": "^[a-z][a-z0-9_]{1,63}$",
+      "title": "Code",
+      "type": "string"
+    },
+    "message": {
+      "maxLength": 500,
+      "minLength": 1,
+      "title": "Message",
+      "type": "string"
+    },
+    "stage": {
+      "anyOf": [
+        {
+          "minLength": 1,
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "title": "Stage"
+    },
+    "retryable": {
+      "default": false,
+      "title": "Retryable",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "code",
+    "message"
+  ],
+  "title": "CaptureFailureV2",
+  "type": "object"
+}

capture_runtime_client/private/schemas/capture-operation-v2.schema.json

@@ -0,0 +1,207 @@
+{
+  "$defs": {
+    "CaptureFailureV2": {
+      "additionalProperties": false,
+      "properties": {
+        "code": {
+          "pattern": "^[a-z][a-z0-9_]{1,63}$",
+          "title": "Code",
+          "type": "string"
+        },
+        "message": {
+          "maxLength": 500,
+          "minLength": 1,
+          "title": "Message",
+          "type": "string"
+        },
+        "stage": {
+          "anyOf": [
+            {
+              "minLength": 1,
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Stage"
+        },
+        "retryable": {
+          "default": false,
+          "title": "Retryable",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "code",
+        "message"
+      ],
+      "title": "CaptureFailureV2",
+      "type": "object"
+    },
+    "CaptureSource": {
+      "additionalProperties": false,
+      "properties": {
+        "sha256": {
+          "pattern": "^[0-9a-f]{64}$",
+          "title": "Sha256",
+          "type": "string"
+        },
+        "fileName": {
+          "maxLength": 255,
+          "minLength": 1,
+          "title": "Filename",
+          "type": "string"
+        },
+        "mediaType": {
+          "minLength": 1,
+          "title": "Mediatype",
+          "type": "string"
+        },
+        "bytes": {
+          "minimum": 1,
+          "title": "Bytes",
+          "type": "integer"
+        }
+      },
+      "required": [
+        "sha256",
+        "fileName",
+        "mediaType",
+        "bytes"
+      ],
+      "title": "CaptureSource",
+      "type": "object"
+    },
+    "CaptureSourceKind": {
+      "enum": [
+        "pdf",
+        "image",
+        "audio"
+      ],
+      "title": "CaptureSourceKind",
+      "type": "string"
+    },
+    "StreamingCaptureStatus": {
+      "enum": [
+        "created",
+        "waiting_input",
+        "extracting",
+        "awaiting_structuring",
+        "structuring",
+        "completed",
+        "failed",
+        "cancelled"
+      ],
+      "title": "StreamingCaptureStatus",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "properties": {
+    "protocolVersion": {
+      "const": "2",
+      "default": "2",
+      "title": "Protocolversion",
+      "type": "string"
+    },
+    "captureId": {
+      "minLength": 1,
+      "title": "Captureid",
+      "type": "string"
+    },
+    "ingestionId": {
+      "minLength": 1,
+      "title": "Ingestionid",
+      "type": "string"
+    },
+    "kind": {
+      "$ref": "#/$defs/CaptureSourceKind",
+      "default": "audio"
+    },
+    "status": {
+      "$ref": "#/$defs/StreamingCaptureStatus"
+    },
+    "progress": {
+      "anyOf": [
+        {
+          "maximum": 1,
+          "minimum": 0,
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "title": "Progress"
+    },
+    "partialRevision": {
+      "minimum": 0,
+      "title": "Partialrevision",
+      "type": "integer"
+    },
+    "lastEventSequence": {
+      "minimum": 0,
+      "title": "Lasteventsequence",
+      "type": "integer"
+    },
+    "source": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/CaptureSource"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null
+    },
+    "error": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/CaptureFailureV2"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null
+    },
+    "createdAt": {
+      "format": "date-time",
+      "title": "Createdat",
+      "type": "string"
+    },
+    "updatedAt": {
+      "format": "date-time",
+      "title": "Updatedat",
+      "type": "string"
+    },
+    "completedAt": {
+      "anyOf": [
+        {
+          "format": "date-time",
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "title": "Completedat"
+    }
+  },
+  "required": [
+    "captureId",
+    "ingestionId",
+    "status",
+    "partialRevision",
+    "lastEventSequence",
+    "createdAt",
+    "updatedAt"
+  ],
+  "title": "CaptureOperationV2",
+  "type": "object"
+}

capture_runtime_client/private/schemas/capture-source.schema.json

@@ -0,0 +1,34 @@
+{
+  "additionalProperties": false,
+  "properties": {
+    "sha256": {
+      "pattern": "^[0-9a-f]{64}$",
+      "title": "Sha256",
+      "type": "string"
+    },
+    "fileName": {
+      "maxLength": 255,
+      "minLength": 1,
+      "title": "Filename",
+      "type": "string"
+    },
+    "mediaType": {
+      "minLength": 1,
+      "title": "Mediatype",
+      "type": "string"
+    },
+    "bytes": {
+      "minimum": 1,
+      "title": "Bytes",
+      "type": "integer"
+    }
+  },
+  "required": [
+    "sha256",
+    "fileName",
+    "mediaType",
+    "bytes"
+  ],
+  "title": "CaptureSource",
+  "type": "object"
+}

capture_runtime_client/private/schemas/error-body-v2.schema.json

@@ -0,0 +1,34 @@
+{
+  "additionalProperties": false,
+  "properties": {
+    "code": {
+      "minLength": 1,
+      "title": "Code",
+      "type": "string"
+    },
+    "message": {
+      "minLength": 1,
+      "title": "Message",
+      "type": "string"
+    },
+    "details": {
+      "anyOf": [
+        {
+          "additionalProperties": true,
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "title": "Details"
+    }
+  },
+  "required": [
+    "code",
+    "message"
+  ],
+  "title": "ErrorBodyV2",
+  "type": "object"
+}

capture_runtime_client/private/schemas/error-envelope-v2.schema.json

@@ -0,0 +1,49 @@
+{
+  "$defs": {
+    "ErrorBodyV2": {
+      "additionalProperties": false,
+      "properties": {
+        "code": {
+          "minLength": 1,
+          "title": "Code",
+          "type": "string"
+        },
+        "message": {
+          "minLength": 1,
+          "title": "Message",
+          "type": "string"
+        },
+        "details": {
+          "anyOf": [
+            {
+              "additionalProperties": true,
+              "type": "object"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Details"
+        }
+      },
+      "required": [
+        "code",
+        "message"
+      ],
+      "title": "ErrorBodyV2",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "properties": {
+    "error": {
+      "$ref": "#/$defs/ErrorBodyV2"
+    }
+  },
+  "required": [
+    "error"
+  ],
+  "title": "ErrorEnvelopeV2",
+  "type": "object"
+}

capture_runtime_client/private/schemas/finalize-ingestion-v2.schema.json

@@ -0,0 +1,27 @@
+{
+  "additionalProperties": false,
+  "properties": {
+    "protocolVersion": {
+      "const": "2",
+      "default": "2",
+      "title": "Protocolversion",
+      "type": "string"
+    },
+    "totalBytes": {
+      "exclusiveMinimum": 0,
+      "title": "Totalbytes",
+      "type": "integer"
+    },
+    "sha256": {
+      "pattern": "^[0-9a-f]{64}$",
+      "title": "Sha256",
+      "type": "string"
+    }
+  },
+  "required": [
+    "totalBytes",
+    "sha256"
+  ],
+  "title": "FinalizeIngestionV2",
+  "type": "object"
+}