{ "$schema": "./authoring-profile.v1.schema.json", "$id": "https://pipelinexlab.com/contracts/authoring-profile.v1.json", "title": "PipelineXLab authoring profile v1", "contractVersion": "1.38.0", "availability": "contract_only", "authority": { "machineProfile": "this document", "exactHumanSpecification": "/specification/sdk-grammar", "sdkGrammar": "/specification/sdk-grammar", "storage": "/specification/serialization-and-files", "toolCatalog": "/integrations/mcp-and-llm#고정-tool-catalog", "functionCommandCatalog": "/specification/operation-parity#project-function-command" }, "python": { "publicImport": "from pipelinexlab import px", "flowModule": { "publicExport": "flow", "publicFlowCount": 1, "importSideEffects": false }, "nodeTarget": { "allowedDecorators": [ "px.function", "px.component" ], "plainDefRole": "helper_only", "explicitStableKey": true, "stableKeyKeyword": "key", "resultShape": "named_px_results" }, "descriptorContracts": { "authority": "authoring-profile-owns-python-decorator-materialization", "typeDescriptorRef": "/contracts/pxflow-direct.v1.schema.json#/$defs/typeDescriptor", "schemas": { "function": { "path": "/contracts/function-descriptor.v1.schema.json", "schemaVersion": 1, "canonicalMembers": [ "schemaVersion", "functionKey", "version", "description", "inputs", "results", "typeDefinitions", "executionPolicy", "capabilities" ], "requiredDecoratorKeywords": [ "key", "version", "description" ] }, "component": { "path": "/contracts/component-descriptor.v1.schema.json", "schemaVersion": 1, "canonicalMembers": [ "schemaVersion", "componentKey", "componentContractVersion", "label", "description", "classification", "category", "subcategory", "typeDefinitions", "inputs", "results", "settings", "execution", "executorEntry", "presentation" ], "requiredDecoratorKeywords": [ "key", "label", "description" ] }, "inputPortMembers": [ "portKey", "type", "description", "unit", "required", "nullable" ], "resultPortMembers": [ "portKey", "type", "description", "unit", "nullable" ] }, "annotationProjection": { "inputs": "function-parameter-annotations-in-declaration-order", "results": "px.Results-field-annotations-in-declaration-order", "nullable": "T-or-None-retains-T-TypeDescriptor-and-sets-nullable", "literal": "sorted-unique-lower-snake-case-enum-values", "unprojectable": "reject-with-px.Error-and-PX_REQUEST_SHAPE_INVALID" }, "diagnostics": { "missingAnnotation": { "code": "PX_REQUEST_SHAPE_INVALID", "params": { "member": "annotation", "reason": "missingAnnotation" } }, "unsupportedAnnotation": { "code": "PX_REQUEST_SHAPE_INVALID", "params": { "member": "annotation", "reason": "unsupportedAnnotation" } }, "duplicateKey": { "code": "PX_KEY_DUPLICATE", "params": { "key": "registered-descriptor-key" } }, "invalidMetadata": { "code": "PX_REQUEST_SHAPE_INVALID", "params": { "member": "metadata", "reason": "invalidMetadata" } } }, "registration": { "duplicateKeyScope": "descriptor-kind", "decoratorExecutesTarget": false, "decoratorPlacesNode": false } }, "exactGrammar": { "flowConstructor": { "callee": "px.Flow", "signature": "px.Flow(flow_key: str, *, label: str, description: str)", "implementationStatus": "implemented", "requiredKeywords": [ "label", "description" ] }, "flowInput": { "callee": "flow.input", "signature": "flow.input(input_key: str, ValueType: object, *, description: str, unit: str | None = None, constraints: dict | None = None) -> '_Port'", "implementationStatus": "implemented", "requiredKeywords": [ "description" ] }, "flowNode": { "callee": "flow.node", "signature": "flow.node(node_key: str, target: object, *, settings: dict | None = None, client: 'Client | None' = None) -> '_Node'", "implementationStatus": "implemented", "requiredKeywords": [] }, "flowConnect": { "callee": "flow.connect", "signature": "flow.connect(source: '_Port', destination: '_Port') -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "flowResult": { "callee": "flow.result", "signature": "flow.result(result_key: str, source: '_Port', *, description: str | None = None) -> '_Port'", "implementationStatus": "implemented", "requiredKeywords": [] }, "flowGroup": { "callee": "flow.group", "signature": "flow.group(group_key: str, *, members: list | tuple, label: str | None = None) -> None", "implementationStatus": "implemented", "requiredKeywords": [ "members" ] }, "flowSubflow": { "callee": "flow.subflow", "signature": "flow.subflow(subflow_key: str, imported_flow: 'Flow', *, label: str | None = None, client: 'Client | None' = None) -> '_Subflow'", "implementationStatus": "implemented", "requiredKeywords": [] }, "flowPreviewHtml": { "callee": "flow.preview_html", "signature": "flow.preview_html(path: str | os.PathLike) -> str", "implementationStatus": "implemented", "requiredKeywords": [] }, "functionDecorator": { "callee": "px.function", "signature": "@px.function(*, key: str, version: str, description: str, policy: dict | None = None, capabilities: dict | None = None, helpers: list | None = None, dependencies: dict | None = None)", "implementationStatus": "implemented", "requiredKeywords": [ "key", "version", "description" ] }, "componentDecorator": { "callee": "px.component", "signature": "@px.component(*, key: str, label: str, description: str, category: str | None = None, subcategory: str | None = None, contract_version: int = 1, executor_entry: str | None = None, icon: str | None = None, summary_results: list | tuple | None = None, settings: type | None = None, deterministic: bool | None = None, cache: str | None = None)", "implementationStatus": "implemented", "requiredKeywords": [ "key", "label", "description" ] }, "codecLoads": { "callee": "px.loads", "signature": "px.loads(data: bytes) -> object", "implementationStatus": "implemented", "requiredKeywords": [] }, "codecDumps": { "callee": "px.dumps", "signature": "px.dumps(document) -> bytes", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportConstructor": { "callee": "px.Report", "signature": "px.Report(report_key: str, *, title: str)", "implementationStatus": "implemented", "requiredKeywords": [ "title" ] }, "reportOpen": { "callee": "px.Report.open", "signature": "px.Report.open(report_key: str, *, workspace: str, project: str, revision: str | None = None) -> 'Report'", "implementationStatus": "implemented", "requiredKeywords": [ "workspace", "project" ] }, "reportSection": { "callee": "report.section", "signature": "report.section(section_key: str, title: str) -> '_Section'", "implementationStatus": "implemented", "requiredKeywords": [] }, "sectionText": { "callee": "section.text", "signature": "section.text(block_key: str, text: str) -> '_ReportBlock'", "implementationStatus": "implemented", "requiredKeywords": [] }, "sectionValue": { "callee": "section.value", "signature": "section.value(value_key: str, value: bool | int | float | str | decimal.Decimal, unit: str) -> '_ReportValue'", "implementationStatus": "implemented", "requiredKeywords": [] }, "sectionTable": { "callee": "section.table", "signature": "section.table(table_key: str, rows: list | tuple, *, row_key: str) -> '_Table'", "implementationStatus": "implemented", "requiredKeywords": [ "row_key" ] }, "tableSelect": { "callee": "table.select", "signature": "table.select(*, rows: list | tuple, fields: list | tuple) -> '_TableSelection'", "implementationStatus": "implemented", "requiredKeywords": [ "rows", "fields" ] }, "sectionResultSlot": { "callee": "section.result_slot", "signature": "section.result_slot(slot_key: str, label: str = ...) -> '_ReportResultSlot'", "implementationStatus": "implemented", "requiredKeywords": [] }, "sectionResultTable": { "callee": "section.result_table", "signature": "section.result_table(table_key: str, *, row_key: str, fields: list | tuple) -> '_ReportResultTable'", "implementationStatus": "implemented", "requiredKeywords": [ "row_key", "fields" ] }, "sectionArtifactSlot": { "callee": "section.artifact_slot", "signature": "section.artifact_slot(slot_key: str, *, label: str, accepts: list | tuple) -> '_ReportArtifactSlot'", "implementationStatus": "implemented", "requiredKeywords": [ "label", "accepts" ] }, "sectionAttachment": { "callee": "section.attachment", "signature": "section.attachment(attachment_key: str, source: str, *, media_type: str) -> '_ReportAttachment'", "implementationStatus": "implemented", "requiredKeywords": [ "media_type" ] }, "reportConnectFlow": { "callee": "report.connect_flow", "signature": "report.connect_flow(connection_key: str, flow: 'Flow') -> '_FlowConnection'", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportConnection": { "callee": "report.connection", "signature": "report.connection(connection_key: str) -> '_FlowConnection'", "implementationStatus": "implemented", "requiredKeywords": [] }, "connectionBind": { "callee": "connection.bind", "signature": "connection.bind(mapping_key: str, source: object, *, to: '_Port', fields: dict | None = None, row_key: dict | None = None) -> None", "implementationStatus": "implemented", "requiredKeywords": [ "to" ] }, "connectionShow": { "callee": "connection.show", "signature": "connection.show(mapping_key: str, source: '_Port', *, at: object, fields: dict | None = None, row_key: dict | None = None) -> None", "implementationStatus": "implemented", "requiredKeywords": [ "at" ] }, "connectionRemoveMapping": { "callee": "connection.remove_mapping", "signature": "connection.remove_mapping(mapping_key: str) -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportMove": { "callee": "report.move", "signature": "report.move(block_key: str, *, to: str | None = None, before: str | None = None, after: str | None = None) -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportRemove": { "callee": "report.remove", "signature": "report.remove(block_key: str) -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportRemoveConnection": { "callee": "report.remove_connection", "signature": "report.remove_connection(connection_key: str) -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportSave": { "callee": "report.save", "signature": "report.save() -> ReportRef", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportPlanPages": { "callee": "report.plan_pages", "signature": "report.plan_pages(page_setup: dict | None = None) -> PagePlan", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportExportPdf": { "callee": "report.export_pdf", "signature": "report.export_pdf(path: str | os.PathLike, page_setup: dict | None = None, on_existing: str = \"refuse\") -> PdfExport", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportPreviewHtml": { "callee": "report.preview_html", "signature": "report.preview_html(path: str | os.PathLike) -> str", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientConstructor": { "callee": "px.Client", "signature": "px.Client(*, workspace: str, project: str, timeout: float | None = ..., service_url: str | None = None, access_token: str | None = None, organization: str | None = None)", "implementationStatus": "implemented", "requiredKeywords": [ "workspace", "project" ] }, "clientCreateProject": { "callee": "client.create_project", "signature": "client.create_project(*, name: str, command_id: str) -> str", "implementationStatus": "implemented", "requiredKeywords": [ "name", "command_id" ] }, "clientSearchCatalog": { "callee": "client.search_catalog", "signature": "client.search_catalog(*, workspace_ref: str, name_prefix: str | None = None, kind: str | None = None, sort: str = \"nameAscending\", limit: int = 50, cursor: str | None = None) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "workspace_ref" ] }, "clientSave": { "callee": "client.save", "signature": "client.save(flow: object) -> FlowRef | ReportRef", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientOpenReport": { "callee": "client.open_report", "signature": "client.open_report(report_key: str, *, revision: str | None = None) -> Report", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientRunFlow": { "callee": "client.run", "signature": "client.run(flow: object, *, run_key: str | None = None, command_id: str | None = None, **inputs: object) -> Run", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientRunConnection": { "callee": "client.run", "signature": "client.run(connection, *, run_key: str | None = None, command_id: str | None = None) -> Run", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientRunMany": { "callee": "client.run_many", "signature": "client.run_many(connections: list | tuple) -> list[Run]", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientRunBatch": { "callee": "client.run_batch", "signature": "client.run_batch(connection: object, cases: list | tuple, *, case_key: str, inputs: dict, result_mapping: str | None = None) -> BatchRun", "implementationStatus": "implemented", "requiredKeywords": [ "case_key", "inputs" ] }, "reportBlock": { "callee": "report.block", "signature": "report.block(block_key: str) -> '_ReportBlock'", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportResultSlot": { "callee": "report.result_slot", "signature": "report.result_slot(slot_key: str) -> '_ReportResultSlot'", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportDocument": { "callee": "report.document", "signature": "report.document() -> 'ReportDocument'", "implementationStatus": "implemented", "requiredKeywords": [] }, "blockToDict": { "callee": "block.to_dict", "signature": "block.to_dict() -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "blockReplace": { "callee": "block.replace", "signature": "block.replace(node: dict, *, expected: dict | None = None) -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "blockSetValue": { "callee": "block.set_value", "signature": "block.set_value(field_key: str, value: bool | int | float | str | decimal.Decimal, *, unit: str) -> '_ReportValue'", "implementationStatus": "implemented", "requiredKeywords": [ "unit" ] }, "blockSelect": { "callee": "block.select", "signature": "block.select(start: int, end: int) -> '_ReportTextSelection'", "implementationStatus": "implemented", "requiredKeywords": [] }, "blockInsertResult": { "callee": "block.insert_result", "signature": "block.insert_result(offset: int, slot: '_ReportResultSlot') -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "selectionFormat": { "callee": "selection.format", "signature": "selection.format(*, bold: bool | None = None, italic: bool | None = None, underline: bool | None = None, font_family: str | None = None, font_size: str | None = None, color: str | None = None) -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "selectionAsValue": { "callee": "selection.as_value", "signature": "selection.as_value(field_key: str, *, type: type, unit: str) -> '_ReportValue'", "implementationStatus": "implemented", "requiredKeywords": [ "type", "unit" ] }, "clientExportDocuments": { "callee": "client.export_documents", "signature": "client.export_documents(output: 'str | os.PathLike', *, flows: dict | None = None, reports: dict | None = None) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportDocumentConstructor": { "callee": "px.ReportDocument", "signature": "px.ReportDocument(data: bytes)", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportDocumentFromWire": { "callee": "px.ReportDocument.from_wire", "signature": "px.ReportDocument.from_wire(document: dict) -> 'ReportDocument'", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentToDict": { "callee": "document.to_dict", "signature": "document.to_dict() -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportSettings": { "callee": "report.settings", "signature": "report.settings() -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportSetSettings": { "callee": "report.set_settings", "signature": "report.set_settings(value: dict, *, expected_version: str | None) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "expected_version" ] }, "clientImportDocuments": { "callee": "client.import_documents", "signature": "client.import_documents(path: 'str | os.PathLike', *, reports: list | tuple | None = None, command_id: 'str | None' = None) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentAnalysisConstructor": { "callee": "px.DocumentAnalysis", "signature": "px.DocumentAnalysis(data: bytes)", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentAnalysisFromWire": { "callee": "px.DocumentAnalysis.from_wire", "signature": "px.DocumentAnalysis.from_wire(document: dict) -> 'DocumentAnalysis'", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentAnalysisToDict": { "callee": "analysis.to_dict", "signature": "analysis.to_dict() -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentAnalysisCitation": { "callee": "analysis.citation", "signature": "analysis.citation(segment_keys: list[str]) -> 'DocumentCitation'", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentCitationConstructor": { "callee": "px.DocumentCitation", "signature": "px.DocumentCitation(data: bytes)", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentCitationFromWire": { "callee": "px.DocumentCitation.from_wire", "signature": "px.DocumentCitation.from_wire(document: dict) -> 'DocumentCitation'", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentCitationToDict": { "callee": "citation.to_dict", "signature": "citation.to_dict() -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentCitationResolve": { "callee": "citation.resolve", "signature": "citation.resolve(analysis: 'DocumentAnalysis') -> list[dict]", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentTranslationConstructor": { "callee": "px.DocumentTranslation", "signature": "px.DocumentTranslation(data: bytes)", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentTranslationFromWire": { "callee": "px.DocumentTranslation.from_wire", "signature": "px.DocumentTranslation.from_wire(document: dict) -> 'DocumentTranslation'", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentTranslationToDict": { "callee": "translation.to_dict", "signature": "translation.to_dict() -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentTranslationResolve": { "callee": "translation.resolve", "signature": "translation.resolve(analysis: 'DocumentAnalysis') -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientRetainDocument": { "callee": "client.retain_document", "signature": "client.retain_document(value: 'str | DocumentAnalysis | DocumentCitation | DocumentTranslation', *, source: 'Report | None' = None) -> str", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientDocumentJob": { "callee": "client.document_job", "signature": "client.document_job(job_ref: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientCancelDocumentJob": { "callee": "client.cancel_document_job", "signature": "client.cancel_document_job(job_ref: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientReviewDocumentJob": { "callee": "client.review_document_job", "signature": "client.review_document_job(job_ref: str, *, result_ref: str, decision: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "result_ref", "decision" ] }, "clientApplyDocumentResult": { "callee": "client.apply_document_result", "signature": "client.apply_document_result(report: 'Report', *, job_ref: str, result_ref: str, command_id: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "job_ref", "result_ref", "command_id" ] }, "clientDocumentApplication": { "callee": "client.document_application", "signature": "client.document_application(command_id: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientResumeDocumentApplication": { "callee": "client.resume_document_application", "signature": "client.resume_document_application(command_id: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientSubmitDocumentJob": { "callee": "client.submit_document_job", "signature": "client.submit_document_job(request: dict, *, command_id: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "command_id" ] }, "clientDocumentSubmission": { "callee": "client.document_submission", "signature": "client.document_submission(command_id: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientDocumentJobResult": { "callee": "client.document_job_result", "signature": "client.document_job_result(job_ref: str) -> 'DocumentAnalysis | DocumentTranslation'", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentTranslatedPdfConstructor": { "callee": "px.DocumentTranslatedPdf", "signature": "px.DocumentTranslatedPdf(data: bytes)", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentTranslatedPdfFromWire": { "callee": "px.DocumentTranslatedPdf.from_wire", "signature": "px.DocumentTranslatedPdf.from_wire(document: dict) -> 'DocumentTranslatedPdf'", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentTranslatedPdfToDict": { "callee": "translated_pdf.to_dict", "signature": "translated_pdf.to_dict() -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "documentTranslatedPdfResolve": { "callee": "translated_pdf.resolve", "signature": "translated_pdf.resolve(analysis: 'DocumentAnalysis', translation: 'DocumentTranslation') -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientRetainTranslatedPdf": { "callee": "client.retain_translated_pdf", "signature": "client.retain_translated_pdf(value: 'DocumentTranslatedPdf', *, pdf: 'str | os.PathLike') -> str", "implementationStatus": "implemented", "requiredKeywords": [] }, "projectPdfFilesConstructor": { "callee": "px.ProjectPdfFiles", "signature": "px.ProjectPdfFiles(directory: str | os.PathLike, *, workspace: str, project: str)", "implementationStatus": "implemented", "requiredKeywords": [ "workspace", "project" ] }, "projectPdfFilesRead": { "callee": "pdf_files.read", "signature": "pdf_files.read(key: str) -> dict | None", "implementationStatus": "implemented", "requiredKeywords": [] }, "projectPdfFilesList": { "callee": "pdf_files.list", "signature": "pdf_files.list() -> list[dict]", "implementationStatus": "implemented", "requiredKeywords": [] }, "projectPdfFilesRemember": { "callee": "pdf_files.remember", "signature": "pdf_files.remember(key: str, *, name: str, content_ref: str, size: int, expected_revision: str | None) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "name", "content_ref", "size", "expected_revision" ] }, "projectPdfFilesImport": { "callee": "pdf_files.import_pdf", "signature": "pdf_files.import_pdf(key: str, path: str | os.PathLike, *, expected_revision: str | None, name: str | None = None) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "expected_revision" ] }, "projectPdfFilesOpen": { "callee": "pdf_files.open_pdf", "signature": "pdf_files.open_pdf(key: str) -> pathlib.Path", "implementationStatus": "implemented", "requiredKeywords": [] }, "reportTable": { "callee": "report.table", "signature": "report.table(table_key: str) -> '_Table'", "implementationStatus": "implemented", "requiredKeywords": [] }, "tableCell": { "callee": "table.cell", "signature": "table.cell(row: str | int, field: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "tableSetCell": { "callee": "table.set_cell", "signature": "table.set_cell(row: str | int, field: str, value: bool | int | float | str | decimal.Decimal, *, expected: dict | None = None) -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "selectionRead": { "callee": "selection.read", "signature": "selection.read() -> str", "implementationStatus": "implemented", "requiredKeywords": [] }, "selectionReplace": { "callee": "selection.replace", "signature": "selection.replace(text: str) -> None", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientReadReport": { "callee": "client.read_report", "signature": "client.read_report(report_key: str, *, revision: str, blocks: list | tuple = (), tables: dict | None = None, attachments: list | tuple = ()) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "revision" ] }, "clientReadAttachment": { "callee": "client.read_attachment", "signature": "client.read_attachment(report_key: str, attachment_key: str, *, revision: str, max_bytes: int = 8388608) -> bytes", "implementationStatus": "implemented", "requiredKeywords": [ "revision" ] }, "reportCaptureContext": { "callee": "report.capture_context", "signature": "report.capture_context(*, reads: list | tuple | None, writes: list | tuple) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "reads", "writes" ] }, "reportApplyEdits": { "callee": "report.apply_edits", "signature": "report.apply_edits(edits: dict, *, context: dict, values: dict | None = None, cells: list | tuple = ()) -> None", "implementationStatus": "implemented", "requiredKeywords": [ "context" ] }, "attachmentCapture": { "callee": "attachment.capture", "signature": "attachment.capture(*, max_bytes: int = 8388608) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "runReadResult": { "callee": "run.read_result", "signature": "run.read_result(name: str, *, max_bytes: int) -> bytes", "implementationStatus": "implemented", "requiredKeywords": [ "max_bytes" ] }, "artifactFromBytes": { "callee": "px.Artifact.from_bytes", "signature": "px.Artifact.from_bytes(data: bytes, *, media_type: str) -> 'Artifact'", "implementationStatus": "implemented", "requiredKeywords": [ "media_type" ] }, "flowViewer": { "callee": "flow.viewer", "signature": "flow.viewer(viewer_key: str, *, results: list | tuple, x: float = 0.0, y: float = 0.0) -> None", "implementationStatus": "implemented", "requiredKeywords": [ "results" ] }, "clientPlanFlowChange": { "callee": "client.plan_flow_change", "signature": "client.plan_flow_change(flow: FlowRef, *, commands: list | tuple) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "commands" ] }, "clientApplyFlowChange": { "callee": "client.apply_flow_change", "signature": "client.apply_flow_change(plan: dict, *, command_id: str) -> FlowRef", "implementationStatus": "implemented", "requiredKeywords": [ "command_id" ] }, "clientSearchFunctions": { "callee": "client.search_functions", "signature": "client.search_functions(*, function_key_prefix: str | None = None, sort: str = \"functionKeyAscending\", limit: int = 50, cursor: str | None = None) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "function_key_prefix", "sort", "limit", "cursor" ] }, "clientDescribeFunction": { "callee": "client.describe_function", "signature": "client.describe_function(function_key: str, *, version: str | None = None) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "version" ] }, "clientPlanFunctionSourceChange": { "callee": "client.plan_function_source_change", "signature": "client.plan_function_source_change(function_key: str, *, version: str, source: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "version", "source" ] }, "clientApplyFunctionChange": { "callee": "client.apply_function_change", "signature": "client.apply_function_change(plan: dict, *, command_id: str) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "command_id" ] }, "clientReadFlowInputDraft": { "callee": "client.read_flow_input_draft", "signature": "client.read_flow_input_draft(flow: FlowRef) -> dict", "implementationStatus": "implemented", "requiredKeywords": [] }, "clientSaveFlowInputDraft": { "callee": "client.save_flow_input_draft", "signature": "client.save_flow_input_draft(flow: FlowRef, values: dict, *, expected_version: str | None, command_id: str | None = None) -> dict", "implementationStatus": "implemented", "requiredKeywords": [ "expected_version" ] }, "clientGetRun": { "callee": "client.get_run", "signature": "client.get_run(run_key: str) -> Run", "implementationStatus": "implemented", "requiredKeywords": [] }, "runReadInputs": { "callee": "run.read_inputs", "signature": "run.read_inputs(*, max_bytes: int) -> bytes", "implementationStatus": "implemented", "requiredKeywords": [ "max_bytes" ] } }, "runtimeValues": { "outputOnlyTypes": [ "px.Run", "px.RunProjection", "px.RunNodeProgress", "px.RunProgress", "px.RunPage", "px.BatchRun", "px.BatchCase", "px.PagePlan", "px.PdfExport", "px.ReportFreshness", "px.ReportResultFreshness" ], "constructorPolicy": "raises-TypeError", "runLifecycleClient": "borrowed-originating-client-must-remain-open", "runDiagnostics": { "sdkMember": "Run.diagnostics", "valueType": "tuple[Diagnostic, ...]", "wirePath": "/data/diagnostics", "readOperation": "run_get", "scope": "terminal-failed-current-attempts", "absentValue": "empty-tuple", "runToDict": "unchanged-run-record" }, "runFlowSource": { "sdkMember": "Run.flow_ref", "valueType": "FlowRef | None", "wirePath": "/data/flowSource", "readOperation": "run_get", "scope": "captured-flow-definition-independent-of-run-custody", "absentValue": "None-no-scope-inference", "runToDict": "unchanged-run-record" }, "runProjection": { "sdkMember": "Run.projection", "valueType": "RunProjection | None", "wirePath": "/data/projection", "readOperation": "run_get", "states": [ "pending", "applied", "refused" ], "refusalReasons": [ "reportProjectionReportChanged", "reportProjectionSuperseded", "reportProjectionResultMissing", "reportProjectionValueUnavailable", "computationFailed", "computationCancelled", "computationIndeterminate", "storageUnavailable" ], "absentValue": "None", "runToDict": "unchanged-run-record" }, "reportFreshness": { "sdkMember": "ReportDocument.freshness", "valueType": "ReportFreshness | None", "wirePath": "/data/freshness", "readOperation": "product.report.read_revision", "schemaVersion": 1, "scope": "exact-saved-revision-at-read-time", "absentValue": "None", "documentSerialization": "unchanged-no-sidecar", "statusReasons": { "current": [ "matches" ], "stale": [ "inputsChanged", "mappingChanged", "flowChanged", "connectionRemoved" ], "unknown": [ "provenanceUnavailable", "sourceUnavailable" ] } } }, "subflowResolution": { "operation": "product.flow.resolve_subflow", "importedFlowArgument": "resolver-verified-px.Flow-handle-never-name", "closureAuthority": "current-Project-installed-Flow-package-dependency-closure", "requestEvidence": "ProjectScope-plus-complete-imported-direct-document", "responsePins": "externalFlowTarget-plus-exact-PackageReleaseRef", "dependencyDeclaration": "exact-resolver-PackageReleaseRef", "validateBoundary": "structural-only-because-pxflow_validate-has-no-Project-scope", "planAudit": "after-candidate-analysis-before-Plan-storage", "applyAudit": "after-candidate-reanalysis-before-Flow-storage", "toolCatalogEffect": "unchanged-fixed-21-Tools", "namedRefusals": [ "ExternalSubflowDependencyNotInstalled", "ImportedFlowRevisionMismatch", "ExternalSubflowDependencyAmbiguous", "ExternalSubflowTargetMismatch", "ExternalSubflowDependencyDeclarationMissing", "ProjectFlowDependencyRecordCorrupt" ] }, "implementationStatusPolicy": { "scope": "python-exact-grammar-only", "humanNotation": "callee | implementationStatus", "implementedMeans": "final-callee-segment-def-or-class-exists-in-any-named-python-package", "doesNotProve": "receiver-signature-or-keyword-conformance", "realityBaselinePins": "searched-packages-and-resolution-pattern-only", "perCalleeTruthOwner": "authoring-profile.v1.json", "approvedClientConstructor": "px.Client(workspace=..., project=...)", "declinedClientConstructor": "px.client()", "declinedConstructorClassification": "contract-mismatch-not-implementation-claim" }, "codec": { "loads": "px.loads", "loadsInput": "bytes", "loadsOutput": "generated_direct_document", "dumps": "px.dumps", "dumpsInput": "generated_direct_document", "dumpsOutput": "bytes", "availability": "implemented", "fileHelpers": false, "streamHelpers": false, "hostOwns": [ "file_lock", "atomic_save", "revision_commit" ] }, "placement": "flow.node", "connection": "flow.connect", "publicInput": "flow.input", "publicResult": "flow.result", "publicResultDescriptionPolicy": "inherit_source_or_override" }, "functionAuthoring": { "writableDefinitionKind": "project_owned_px_function", "dependencyFunctionSource": "read_only_in_consumer_project", "dependencyComponentSource": "read_only_in_consumer_project", "tools": { "search": "function_search", "describe": "function_describe", "validate": "function_validate_change", "plan": "function_plan_change", "apply": "function_apply_change" }, "commands": { "create": "CreateProjectFunction", "createVersion": "CreateFunctionVersion", "branch": "BranchProjectFunction", "replaceNodeTarget": "ReplaceNodeTarget" }, "versioning": { "existingVersionMutation": false, "editCreatesImmutableVersion": true }, "edit": { "referencePolicy": "all_current_usages", "impactKinds": [ "functionSource", "functionVersion", "nodeUsage", "flowRevision", "reportConnection" ], "atomicReferenceUpdate": true }, "singleNodeVariation": { "mode": "branch", "commands": [ "BranchProjectFunction", "ReplaceNodeTarget" ] }, "sourceMutation": { "rawPatch": false, "hiddenSymbolInference": false, "identityAnchor": "explicit_decorator_key", "diff": "source_safe", "rematerializeParityRequired": true } }, "report": { "create": "px.Report", "open": "px.Report.open", "save": "report.save", "editMethods": [ "report.section", "report.connect_flow", "report.move", "report.remove", "connection.remove_mapping", "report.remove_connection" ], "canonicalDocument": ".pxreport", "optimisticConcurrency": [ "baseRevisionRef", "expectedGeneration" ], "openScope": [ "workspace", "project" ], "attachmentIngest": { "operation": "product.report.ingest_attachment", "sourceKinds": [ "local-file-path", "RFC-002-PublicDigestRef" ], "durableValueStorage": "canonical-input-payload-bytes-in-filesystem-CAS", "durableCarrier": "RFC-002-PublicDigestRef", "sizeOwner": "supervisor-byte-reader", "commitTiming": "report.save-before-Plan;explicit-capture-freezes-draft-bytes-without-commit", "planVerification": "reachable-CAS-bytes-and-exact-recorded-size" }, "attachmentRead": { "operation": "product.report.read_attachment_chunk", "namespace": "product-surface-not-tool-or-public-python-method", "arguments": [ "target", "contentRef", "offset" ], "target": "exact-ReportTarget-with-revisionRef", "authorization": "authenticated-report-read-and-contentRef-present-in-that-revision-body-or-attachment-registry", "source": "reachable-CAS-bytes-with-matching-digest-and-recorded-size", "chunkMaxBytes": 65536, "responseMembers": [ "contentRef", "mime", "size", "offset", "bytes" ], "bytesEncoding": "JSON-array-of-integers-0-through-255", "offsetUnit": "bytes", "endOfContent": "offset-equals-size-returns-empty-bytes", "clientVerification": "contiguous-chunks-exact-size-and-final-SHA-256", "documentMutation": "none-Blob-URLs-are-view-owned-and-never-saved" }, "mapping": { "inputMethod": "connection.bind", "resultMethod": "connection.show", "explicitMappingKey": true, "inputSources": [ "reportValue", "reportTableSelection", "reportAttachment" ], "resultTargets": [ "reportResultSlot", "reportTableResult", "reportArtifactSlot" ] } }, "runtime": { "clientScope": [ "workspace", "project" ], "runIdentity": { "signature": "client.run(flow: object, *, run_key: str | None = None, command_id: str | None = None, **inputs: object) -> Run", "issuer": "caller-at-client-call-boundary", "omittedValueRule": "omit both identifiers to create a fresh pair and a new Run; supplying only one is refused before submission", "providedValueRule": "Flow, saved FlowRef and Report connection retries use the same run_key, command_id, exact revision and inputs; a changed request under the same identity is refused", "failureFields": [ "run_key", "command_id", "outcome_unknown" ], "recoveryScope": "Report connection handles retained in the caller process may retry through a new Client in the same Project. Reconstructing a connection handle after caller process restart is not yet supported; no automatic journal or implicit resubmission is provided. Saved FlowRef addresses can be reconstructed in a fresh process and retried with the original exact revision, inputs, run_key and command_id; they never select the latest head or re-register Function source.", "reservedInputNames": [ "run_key", "command_id" ], "runKeyWirePath": "/target/runKey", "commandIdWirePath": "/commandId", "supervisorPreallocation": false, "rationale": "only the caller knows whether a repeated call is the same intent or a new intent; pxflow_apply_change already receives /commandId from its caller, and supervisor preallocation could leave an ownerless Run reservation if issuance and submission disconnect" }, "importIdentity": { "signature": "client.import_documents(path: 'str | os.PathLike', *, reports: list | tuple | None = None, command_id: 'str | None' = None) -> dict", "issuer": "caller-or-minted-once-per-invocation-before-any-send", "perReportCommandId": "sha256-of-invocation-id-target-scope-and-report-key-tuple", "requestDigest": "server-derived-from-operation-domain-target-scope-and-key-canonical-document-digest-canonical-settings-value-and-sorted-attachment-ref-size-list", "replay": "same-command-id-and-digest-returns-recorded-receipt-revision", "conflict": "same-command-id-different-digest-is-PX_RUN_STATE_CONFLICT-commandBodyConflict", "attachmentTransport": "connection-owned-verified-stage-handles-consumed-on-success-reupload-on-retry-reachability-inside-import-transaction", "failureFields": [ "accepted_documents", "failed_index", "command_id", "outcome_unknown" ] }, "connectionAdmission": { "workers": 16, "queueCapacity": 32, "requestOrdering": "sequential-per-connection", "overflow": "close-new-connection", "storageConflictRule": "existing-generation-and-transaction-checks" }, "payloadTransfer": { "version": 1, "operation": "product.runtime.transfer", "negotiation": "optional-runtime-handshake-capability", "capSelection": "min-positive-integer-advertisement-and-client-limit", "invalidAdvertisement": "PX_RUNTIME_INCOMPATIBLE-and-close-no-fallback", "absentCapability": "missing-null-or-empty-object-keeps-frame-limited-transport", "readMaxBytes": "optional-positive-integer-upper-bound-required-when-server-chunk-exceeds-client-limit", "frameMaxBytes": 1048576, "maxPayloadBytes": 33554432, "chunkMaxBytes": 65536, "maxRetainedBytes": 134217728, "operations": [ "report_plan_change", "report_describe", "product.report.read_revision", "product.report.plan_pages", "product.report.import_document", "product.document.retain", "product.document.retain_translated_pdf", "product.report.read_content_closure", "product.flow.materialize" ], "attachmentStaging": "verified-upload-stage-finalizes-unreachable-content-and-retains-connection-proof-required-by-direct-and-wrapped-import", "contentRef": "connection-owned-ephemeral-sha256", "commit": "verified-request-then-existing-plan-and-one-atomic-apply", "cleanup": "on-final-response-chunk-replacement-or-connection-close", "stagedReferenceLimit": 4096, "stagedReferenceCleanup": "consume-used-proofs-on-success-retain-on-refusal-drop-on-connection-close" }, "timeouts": { "connect": "separate-connection-establishment-budget", "request": "one-monotonic-deadline-including-all-transfer-chunks", "execution": "separate-function-execution-policy", "timeoutMeansCancellation": false, "unbounded": "timeout=None", "verifiedCarrier": "unix-socket", "windowsStatus": "named-pipe-read-polling-only; blocking-connect-and-write-deadlines-unverified" }, "collectionInputRunCount": 1, "batch": { "explicit": true, "oneChildRunPerCase": true, "caseInputsMayTargetSavedMappedPort": false, "mergeOrder": "stable_case_key" }, "documentRetention": { "operation": "product.document.retain", "values": [ "pdf-content-ref", "DocumentAnalysis", "DocumentCitation", "DocumentTranslation" ], "source": "exact-saved-Report-required-only-for-PDF-reference-same-Client-and-scope", "parents": "must-already-be-retained-in-this-scope-no-implicit-parent-writes", "identity": "Core-canonical-content-ref-idempotent-immutable-retention", "authority": "Host-resolved-document-custody-current-repository-authorization-each-call", "availableProfile": "explicit-stable-standalone-desktop-local", "otherProfiles": "refuse-until-Host-document-authority-is-resolved-no-catalog-visibility-fallback", "maxDerivedBytes": 16777216, "reportMutation": "none", "engineExecutionAttestation": false, "translatedPdf": { "operation": "product.document.retain_translated_pdf", "value": "DocumentTranslatedPdf", "pdf": "owned-connection-staged-ref-and-size-verified-file", "parents": "same-scoped-retained-source-PDF-Analysis-Translation", "atomicity": "output-PDF-provenance-edges-and-reachability", "identity": "distinct-provenance-digest-shared-PDF-bytes", "reportMutation": "none", "engineExecutionAttestation": false } }, "documentPortability": { "exportReadOperations": [ "product.report.read_content_closure", "product.document.read_content_chunk" ], "importOperation": "product.report.import_document", "importOptionalMember": "contentClosure", "selection": "exact-saved-Report-inventory-registered-roots-and-transitive-parents-only", "exportManifest": "V1-without-retained-roots-V2-with-documentContents-per-selected-Report", "importVersions": [ 1, 2 ], "closure": "Core-document-content-closure-V1-or-V2-generated-PDF", "exportAuthority": "Host-resolved-document-custody-required-for-every-selected-Report-refuse-unresolved-profiles", "importAuthority": "V2-Host-resolved-destination-document-custody-V1-legacy-Report-import", "material": "full-direct-and-transitive-union-verified-staged-on-importing-connection-owned-files-revalidated-by-repository", "atomicity": "per-Report-document-head-settings-reachability-retention-edges-provenance-and-command-receipt", "provenance": "preserve-original-sourceReport-record-destination-import-separately-no-origin-permission-claim", "maxMaterialBytes": 33554432, "gcIntegration": false }, "documentJobs": { "operations": [ "product.document.job_get", "product.document.job_cancel", "product.document.job_review" ], "snapshotSchema": "document-job-snapshot.v1.schema.json", "scope": "current-Client-Project", "authorization": "fresh-Host-custody-no-wire-capabilities-managed-grant-not-synthesized", "cancel": "recorded-origin-and-current-read-create-rights-worker-confirms-running-termination", "review": "exact-successful-result-human-read-create-rights-monotonic-review-no-Report-mutation", "submission": "public-document-compute-v1-through-approved-Host", "resultRead": { "operations": [ "product.document.job_get", "product.document.read_content_chunk" ], "returnTypes": [ "DocumentAnalysis", "DocumentTranslation" ], "maxBytes": 16777216, "identity": "exact-content-digest-canonical-value-and-original-source-reference", "authorization": "current-Project-read-per-chunk-no-implicit-review-or-Report-mutation" } }, "documentApplications": { "operations": [ "product.document.application_approve", "product.document.application_get", "product.document.application_resume" ], "snapshotSchema": "document-application-snapshot.v1.schema.json", "scope": "current-Client-Project", "approval": "exact-Plan-after-accepted-result-review-no-Report-mutation", "application": "atomic-Report-head-command-receipt-and-applied-state", "recovery": "caller-command-ID-query-is-read-only-resume-rechecks-current-origin-and-rights", "states": [ "pending", "applied", "refused" ], "refusedDraft": "reopen-Report-and-prepare-new-change-under-new-command-ID", "authorization": "fresh-Host-custody-no-wire-capabilities-managed-grant-not-synthesized" }, "documentSubmissions": { "operations": [ "product.document.job_submit", "product.document.submission_get" ], "requestSchema": "document-compute-request.v1.schema.json", "snapshotSchema": "document-submission-snapshot.v1.schema.json", "scope": "current-Client-Project", "identity": "canonical-request-and-recorded-origin-no-caller-job-ID", "recovery": "scoped-command-receipt-before-engine-and-source-read-same-body-replay-different-body-conflict", "authorization": "fresh-read-for-receipts-current-approved-Host-and-source-rights-for-new-admission", "execution": "Runtime-owned-local-only-no-wire-engine-path-or-capabilities", "requestByteLimit": 1048576 } }, "llm": { "authoritativeMutationPath": [ "search", "describe", "validate", "plan", "apply" ], "rawDocumentMutation": false, "implicitCurrentProject": false, "applyAtomic": true, "functionDiscoveryPath": [ "function_search", "function_describe" ], "functionMutationPath": [ "function_validate_change", "function_plan_change", "function_apply_change" ], "generatedPythonIsExecutionAuthority": false }, "canonicalScalarKinds": [ "boolean", "int64", "float64", "decimal", "string", "date", "timestamp", "duration", "enum", "binary" ] }