SDK Models

This documentation auto-generates details about the Pydantic models used in the SDK.

For the most part, these models are used to define the API interface.

Imports

Import process classes for the Destiny SDK.

pydantic model libs.sdk.src.destiny_sdk.imports.ImportBatchIn

Input for creating an import batch.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "ImportBatchIn",
   "description": "Input for creating an import batch.",
   "type": "object",
   "properties": {
      "storage_url": {
         "description": "\nThe URL at which the set of references for this batch are stored. The file is a jsonl\nwith each line formatted according to\n:class:`ReferenceFileInput <libs.sdk.src.destiny_sdk.references.ReferenceFileInput>`.\n    ",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "Storage Url",
         "type": "string"
      }
   },
   "required": [
      "storage_url"
   ]
}

Fields:

• storage_url (pydantic.networks.HttpUrl)

field storage_url: HttpUrl [Required]

The URL at which the set of references for this batch are stored. The file is a jsonl with each line formatted according to ReferenceFileInput.

pydantic model libs.sdk.src.destiny_sdk.imports.ImportBatchRead

Core import batch class.

Show Entity Relationship Diagram

Show JSON schema

{
   "$defs": {
      "ImportBatchRead": {
         "description": "Core import batch class.",
         "properties": {
            "storage_url": {
               "description": "\nThe URL at which the set of references for this batch are stored. The file is a jsonl\nwith each line formatted according to\n:class:`ReferenceFileInput <libs.sdk.src.destiny_sdk.references.ReferenceFileInput>`.\n    ",
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "title": "Storage Url",
               "type": "string"
            },
            "id": {
               "description": "The ID of the import batch",
               "format": "uuid4",
               "title": "Id",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/ImportBatchStatus",
               "default": "created",
               "description": "The status of the batch."
            },
            "import_record_id": {
               "description": "The ID of the import record this batch is associated with",
               "format": "uuid4",
               "title": "Import Record Id",
               "type": "string"
            },
            "import_record": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ImportRecordRead"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The parent import record."
            },
            "import_results": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ImportResultRead"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The results from processing the batch.",
               "title": "Import Results"
            }
         },
         "required": [
            "storage_url",
            "id",
            "import_record_id"
         ],
         "title": "ImportBatchRead",
         "type": "object"
      },
      "ImportBatchStatus": {
         "description": "Describes the status of an import batch.",
         "enum": [
            "created",
            "started",
            "failed",
            "partially_failed",
            "completed"
         ],
         "title": "ImportBatchStatus",
         "type": "string"
      },
      "ImportRecordRead": {
         "description": "Core import record class.",
         "properties": {
            "search_string": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The search string used to produce this import",
               "title": "Search String"
            },
            "searched_at": {
               "description": "\nThe timestamp (including timezone) at which the search which produced\nthis import was conducted. If no timezone is included, the timestamp\nis assumed to be in UTC.\n        ",
               "format": "date-time",
               "title": "Searched At",
               "type": "string"
            },
            "processor_name": {
               "description": "The name of the processor that is importing the data.",
               "title": "Processor Name",
               "type": "string"
            },
            "processor_version": {
               "description": "The version of the processor that is importing the data.",
               "title": "Processor Version",
               "type": "string"
            },
            "notes": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\nAny additional notes regarding the import (eg. reason for importing, known\nissues).\n        ",
               "title": "Notes"
            },
            "expected_reference_count": {
               "description": "\nThe number of references expected to be included in this import.\n-1 is accepted if the number is unknown.\n",
               "minimum": -1,
               "title": "Expected Reference Count",
               "type": "integer"
            },
            "source_name": {
               "description": "The source of the reference being imported (eg. Open Alex)",
               "title": "Source Name",
               "type": "string"
            },
            "id": {
               "description": "The ID of the import record",
               "format": "uuid4",
               "title": "Id",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/ImportRecordStatus",
               "default": "created",
               "description": "The status of the import record"
            },
            "batches": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ImportBatchRead"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of batches for the import record",
               "title": "Batches"
            }
         },
         "required": [
            "processor_name",
            "processor_version",
            "expected_reference_count",
            "source_name",
            "id"
         ],
         "title": "ImportRecordRead",
         "type": "object"
      },
      "ImportRecordStatus": {
         "description": "Describes the status of an import record.",
         "enum": [
            "created",
            "started",
            "completed"
         ],
         "title": "ImportRecordStatus",
         "type": "string"
      },
      "ImportResultRead": {
         "description": "Core import result class.",
         "properties": {
            "id": {
               "description": "The ID of the import result.",
               "format": "uuid4",
               "title": "Id",
               "type": "string"
            },
            "reference_id": {
               "anyOf": [
                  {
                     "format": "uuid4",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the reference created by this import result.",
               "title": "Reference Id"
            },
            "failure_details": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The details of the failure, if the import result failed.",
               "title": "Failure Details"
            },
            "import_batch": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ImportBatchRead"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The parent import batch."
            }
         },
         "required": [
            "id"
         ],
         "title": "ImportResultRead",
         "type": "object"
      }
   },
   "$ref": "#/$defs/ImportBatchRead"
}

Fields:

• id (uuid.UUID)

• import_record (libs.sdk.src.destiny_sdk.imports.ImportRecordRead | None)

• import_record_id (uuid.UUID)

• import_results (list[libs.sdk.src.destiny_sdk.imports.ImportResultRead] | None)

• status (libs.sdk.src.destiny_sdk.imports.ImportBatchStatus)

• storage_url (pydantic.networks.HttpUrl)

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the import batch

Constraints:

• uuid_version = 4

field import_record: ImportRecordRead | None = None

The parent import record.

field import_record_id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the import record this batch is associated with

Constraints:

• uuid_version = 4

field import_results: list[ImportResultRead] | None = None

The results from processing the batch.

field status: ImportBatchStatus = ImportBatchStatus.CREATED

The status of the batch.

field storage_url: HttpUrl [Required]

The URL at which the set of references for this batch are stored. The file is a jsonl with each line formatted according to ReferenceFileInput.

class libs.sdk.src.destiny_sdk.imports.ImportBatchStatus(*values)

Describes the status of an import batch.

COMPLETED = 'completed'

Processing has been completed.

CREATED = 'created'

Created, but no processing has started.

FAILED = 'failed'

Processing has failed.

PARTIALLY_FAILED = 'partially_failed'

Some references succeeded while others failed.

STARTED = 'started'

Processing has started on the batch.

pydantic model libs.sdk.src.destiny_sdk.imports.ImportBatchSummary

A view for an import batch that includes a summary of its results.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "ImportBatchSummary",
   "description": "A view for an import batch that includes a summary of its results.",
   "type": "object",
   "properties": {
      "storage_url": {
         "description": "\nThe URL at which the set of references for this batch are stored. The file is a jsonl\nwith each line formatted according to\n:class:`ReferenceFileInput <libs.sdk.src.destiny_sdk.references.ReferenceFileInput>`.\n    ",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "Storage Url",
         "type": "string"
      },
      "id": {
         "description": "\nThe identifier of the batch.\n",
         "format": "uuid4",
         "title": "Id",
         "type": "string"
      },
      "import_batch_id": {
         "description": "The ID of the batch being summarised",
         "format": "uuid4",
         "title": "Import Batch Id",
         "type": "string"
      },
      "import_batch_status": {
         "$ref": "#/$defs/ImportBatchStatus",
         "description": "The status of the batch being summarised"
      },
      "results": {
         "additionalProperties": {
            "type": "integer"
         },
         "description": "A count of references by their current import status.",
         "propertyNames": {
            "$ref": "#/$defs/ImportResultStatus"
         },
         "title": "Results",
         "type": "object"
      },
      "failure_details": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "description": "\n        The details of the failures that occurred.\n        Each failure will start with `\"Entry x\"` where x is the line number of the\n        jsonl object attempted to be imported.\n        ",
         "title": "Failure Details"
      }
   },
   "$defs": {
      "ImportBatchStatus": {
         "description": "Describes the status of an import batch.",
         "enum": [
            "created",
            "started",
            "failed",
            "partially_failed",
            "completed"
         ],
         "title": "ImportBatchStatus",
         "type": "string"
      },
      "ImportResultStatus": {
         "description": "Describes the status of an import result.",
         "enum": [
            "created",
            "started",
            "completed",
            "partially_failed",
            "failed",
            "retrying"
         ],
         "title": "ImportResultStatus",
         "type": "string"
      }
   },
   "required": [
      "storage_url",
      "id",
      "import_batch_id",
      "import_batch_status",
      "results",
      "failure_details"
   ]
}

Fields:

• failure_details (list[str] | None)

• id (uuid.UUID)

• import_batch_id (uuid.UUID)

• import_batch_status (libs.sdk.src.destiny_sdk.imports.ImportBatchStatus)

• results (dict[libs.sdk.src.destiny_sdk.imports.ImportResultStatus, int])

• storage_url (pydantic.networks.HttpUrl)

field failure_details: list[str] | None [Required]

The details of the failures that occurred. Each failure will start with “Entry x” where x is the line number of the jsonl object attempted to be imported.

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The identifier of the batch.

Constraints:

• uuid_version = 4

field import_batch_id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the batch being summarised

Constraints:

• uuid_version = 4

field import_batch_status: ImportBatchStatus [Required]

The status of the batch being summarised

field results: dict[ImportResultStatus, int] [Required]

A count of references by their current import status.

field storage_url: HttpUrl [Required]

The URL at which the set of references for this batch are stored. The file is a jsonl with each line formatted according to ReferenceFileInput.

pydantic model libs.sdk.src.destiny_sdk.imports.ImportRecordIn

Input for creating an import record.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "ImportRecordIn",
   "description": "Input for creating an import record.",
   "type": "object",
   "properties": {
      "search_string": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The search string used to produce this import",
         "title": "Search String"
      },
      "searched_at": {
         "description": "\nThe timestamp (including timezone) at which the search which produced\nthis import was conducted. If no timezone is included, the timestamp\nis assumed to be in UTC.\n        ",
         "format": "date-time",
         "title": "Searched At",
         "type": "string"
      },
      "processor_name": {
         "description": "The name of the processor that is importing the data.",
         "title": "Processor Name",
         "type": "string"
      },
      "processor_version": {
         "description": "The version of the processor that is importing the data.",
         "title": "Processor Version",
         "type": "string"
      },
      "notes": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nAny additional notes regarding the import (eg. reason for importing, known\nissues).\n        ",
         "title": "Notes"
      },
      "expected_reference_count": {
         "description": "\nThe number of references expected to be included in this import.\n-1 is accepted if the number is unknown.\n",
         "minimum": -1,
         "title": "Expected Reference Count",
         "type": "integer"
      },
      "source_name": {
         "description": "The source of the reference being imported (eg. Open Alex)",
         "title": "Source Name",
         "type": "string"
      }
   },
   "required": [
      "processor_name",
      "processor_version",
      "expected_reference_count",
      "source_name"
   ]
}

Fields:

• expected_reference_count (int)

• notes (str | None)

• processor_name (str)

• processor_version (str)

• search_string (str | None)

• searched_at (pydantic.types.PastDatetime)

• source_name (str)

field expected_reference_count: int [Required]

The number of references expected to be included in this import. -1 is accepted if the number is unknown.

Constraints:

• ge = -1

field notes: str | None = None

Any additional notes regarding the import (eg. reason for importing, known issues).

field processor_name: str [Required]

The name of the processor that is importing the data.

field processor_version: str [Required]

The version of the processor that is importing the data.

field search_string: str | None = None

The search string used to produce this import

field searched_at: PastDatetime [Optional]

The timestamp (including timezone) at which the search which produced this import was conducted. If no timezone is included, the timestamp is assumed to be in UTC.

field source_name: str [Required]

The source of the reference being imported (eg. Open Alex)

pydantic model libs.sdk.src.destiny_sdk.imports.ImportRecordRead

Core import record class.

Show Entity Relationship Diagram

Show JSON schema

{
   "$defs": {
      "ImportBatchRead": {
         "description": "Core import batch class.",
         "properties": {
            "storage_url": {
               "description": "\nThe URL at which the set of references for this batch are stored. The file is a jsonl\nwith each line formatted according to\n:class:`ReferenceFileInput <libs.sdk.src.destiny_sdk.references.ReferenceFileInput>`.\n    ",
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "title": "Storage Url",
               "type": "string"
            },
            "id": {
               "description": "The ID of the import batch",
               "format": "uuid4",
               "title": "Id",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/ImportBatchStatus",
               "default": "created",
               "description": "The status of the batch."
            },
            "import_record_id": {
               "description": "The ID of the import record this batch is associated with",
               "format": "uuid4",
               "title": "Import Record Id",
               "type": "string"
            },
            "import_record": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ImportRecordRead"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The parent import record."
            },
            "import_results": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ImportResultRead"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The results from processing the batch.",
               "title": "Import Results"
            }
         },
         "required": [
            "storage_url",
            "id",
            "import_record_id"
         ],
         "title": "ImportBatchRead",
         "type": "object"
      },
      "ImportBatchStatus": {
         "description": "Describes the status of an import batch.",
         "enum": [
            "created",
            "started",
            "failed",
            "partially_failed",
            "completed"
         ],
         "title": "ImportBatchStatus",
         "type": "string"
      },
      "ImportRecordRead": {
         "description": "Core import record class.",
         "properties": {
            "search_string": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The search string used to produce this import",
               "title": "Search String"
            },
            "searched_at": {
               "description": "\nThe timestamp (including timezone) at which the search which produced\nthis import was conducted. If no timezone is included, the timestamp\nis assumed to be in UTC.\n        ",
               "format": "date-time",
               "title": "Searched At",
               "type": "string"
            },
            "processor_name": {
               "description": "The name of the processor that is importing the data.",
               "title": "Processor Name",
               "type": "string"
            },
            "processor_version": {
               "description": "The version of the processor that is importing the data.",
               "title": "Processor Version",
               "type": "string"
            },
            "notes": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\nAny additional notes regarding the import (eg. reason for importing, known\nissues).\n        ",
               "title": "Notes"
            },
            "expected_reference_count": {
               "description": "\nThe number of references expected to be included in this import.\n-1 is accepted if the number is unknown.\n",
               "minimum": -1,
               "title": "Expected Reference Count",
               "type": "integer"
            },
            "source_name": {
               "description": "The source of the reference being imported (eg. Open Alex)",
               "title": "Source Name",
               "type": "string"
            },
            "id": {
               "description": "The ID of the import record",
               "format": "uuid4",
               "title": "Id",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/ImportRecordStatus",
               "default": "created",
               "description": "The status of the import record"
            },
            "batches": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ImportBatchRead"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of batches for the import record",
               "title": "Batches"
            }
         },
         "required": [
            "processor_name",
            "processor_version",
            "expected_reference_count",
            "source_name",
            "id"
         ],
         "title": "ImportRecordRead",
         "type": "object"
      },
      "ImportRecordStatus": {
         "description": "Describes the status of an import record.",
         "enum": [
            "created",
            "started",
            "completed"
         ],
         "title": "ImportRecordStatus",
         "type": "string"
      },
      "ImportResultRead": {
         "description": "Core import result class.",
         "properties": {
            "id": {
               "description": "The ID of the import result.",
               "format": "uuid4",
               "title": "Id",
               "type": "string"
            },
            "reference_id": {
               "anyOf": [
                  {
                     "format": "uuid4",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the reference created by this import result.",
               "title": "Reference Id"
            },
            "failure_details": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The details of the failure, if the import result failed.",
               "title": "Failure Details"
            },
            "import_batch": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ImportBatchRead"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The parent import batch."
            }
         },
         "required": [
            "id"
         ],
         "title": "ImportResultRead",
         "type": "object"
      }
   },
   "$ref": "#/$defs/ImportRecordRead"
}

Fields:

• batches (list[libs.sdk.src.destiny_sdk.imports.ImportBatchRead] | None)

• expected_reference_count (int)

• id (uuid.UUID)

• notes (str | None)

• processor_name (str)

• processor_version (str)

• search_string (str | None)

• searched_at (pydantic.types.PastDatetime)

• source_name (str)

• status (libs.sdk.src.destiny_sdk.imports.ImportRecordStatus)

field batches: list[ImportBatchRead] | None = None

A list of batches for the import record

field expected_reference_count: int [Required]

The number of references expected to be included in this import. -1 is accepted if the number is unknown.

Constraints:

• ge = -1

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the import record

Constraints:

• uuid_version = 4

field notes: str | None = None

Any additional notes regarding the import (eg. reason for importing, known issues).

field processor_name: str [Required]

The name of the processor that is importing the data.

field processor_version: str [Required]

The version of the processor that is importing the data.

field search_string: str | None = None

The search string used to produce this import

field searched_at: PastDatetime [Optional]

The timestamp (including timezone) at which the search which produced this import was conducted. If no timezone is included, the timestamp is assumed to be in UTC.

field source_name: str [Required]

The source of the reference being imported (eg. Open Alex)

field status: ImportRecordStatus = ImportRecordStatus.CREATED

The status of the import record

class libs.sdk.src.destiny_sdk.imports.ImportRecordStatus(*values)

Describes the status of an import record.

COMPLETED = 'completed'

Processing has been completed.

CREATED = 'created'

Created, but no processing has started.

STARTED = 'started'

Processing has started on the batch.

pydantic model libs.sdk.src.destiny_sdk.imports.ImportResultRead

Core import result class.

Show Entity Relationship Diagram

Show JSON schema

{
   "$defs": {
      "ImportBatchRead": {
         "description": "Core import batch class.",
         "properties": {
            "storage_url": {
               "description": "\nThe URL at which the set of references for this batch are stored. The file is a jsonl\nwith each line formatted according to\n:class:`ReferenceFileInput <libs.sdk.src.destiny_sdk.references.ReferenceFileInput>`.\n    ",
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "title": "Storage Url",
               "type": "string"
            },
            "id": {
               "description": "The ID of the import batch",
               "format": "uuid4",
               "title": "Id",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/ImportBatchStatus",
               "default": "created",
               "description": "The status of the batch."
            },
            "import_record_id": {
               "description": "The ID of the import record this batch is associated with",
               "format": "uuid4",
               "title": "Import Record Id",
               "type": "string"
            },
            "import_record": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ImportRecordRead"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The parent import record."
            },
            "import_results": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ImportResultRead"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The results from processing the batch.",
               "title": "Import Results"
            }
         },
         "required": [
            "storage_url",
            "id",
            "import_record_id"
         ],
         "title": "ImportBatchRead",
         "type": "object"
      },
      "ImportBatchStatus": {
         "description": "Describes the status of an import batch.",
         "enum": [
            "created",
            "started",
            "failed",
            "partially_failed",
            "completed"
         ],
         "title": "ImportBatchStatus",
         "type": "string"
      },
      "ImportRecordRead": {
         "description": "Core import record class.",
         "properties": {
            "search_string": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The search string used to produce this import",
               "title": "Search String"
            },
            "searched_at": {
               "description": "\nThe timestamp (including timezone) at which the search which produced\nthis import was conducted. If no timezone is included, the timestamp\nis assumed to be in UTC.\n        ",
               "format": "date-time",
               "title": "Searched At",
               "type": "string"
            },
            "processor_name": {
               "description": "The name of the processor that is importing the data.",
               "title": "Processor Name",
               "type": "string"
            },
            "processor_version": {
               "description": "The version of the processor that is importing the data.",
               "title": "Processor Version",
               "type": "string"
            },
            "notes": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\nAny additional notes regarding the import (eg. reason for importing, known\nissues).\n        ",
               "title": "Notes"
            },
            "expected_reference_count": {
               "description": "\nThe number of references expected to be included in this import.\n-1 is accepted if the number is unknown.\n",
               "minimum": -1,
               "title": "Expected Reference Count",
               "type": "integer"
            },
            "source_name": {
               "description": "The source of the reference being imported (eg. Open Alex)",
               "title": "Source Name",
               "type": "string"
            },
            "id": {
               "description": "The ID of the import record",
               "format": "uuid4",
               "title": "Id",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/ImportRecordStatus",
               "default": "created",
               "description": "The status of the import record"
            },
            "batches": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ImportBatchRead"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of batches for the import record",
               "title": "Batches"
            }
         },
         "required": [
            "processor_name",
            "processor_version",
            "expected_reference_count",
            "source_name",
            "id"
         ],
         "title": "ImportRecordRead",
         "type": "object"
      },
      "ImportRecordStatus": {
         "description": "Describes the status of an import record.",
         "enum": [
            "created",
            "started",
            "completed"
         ],
         "title": "ImportRecordStatus",
         "type": "string"
      },
      "ImportResultRead": {
         "description": "Core import result class.",
         "properties": {
            "id": {
               "description": "The ID of the import result.",
               "format": "uuid4",
               "title": "Id",
               "type": "string"
            },
            "reference_id": {
               "anyOf": [
                  {
                     "format": "uuid4",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the reference created by this import result.",
               "title": "Reference Id"
            },
            "failure_details": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The details of the failure, if the import result failed.",
               "title": "Failure Details"
            },
            "import_batch": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ImportBatchRead"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The parent import batch."
            }
         },
         "required": [
            "id"
         ],
         "title": "ImportResultRead",
         "type": "object"
      }
   },
   "$ref": "#/$defs/ImportResultRead"
}

Fields:

• failure_details (str | None)

• id (uuid.UUID)

• import_batch (libs.sdk.src.destiny_sdk.imports.ImportBatchRead | None)

• reference_id (uuid.UUID | None)

field failure_details: str | None = None

The details of the failure, if the import result failed.

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the import result.

Constraints:

• uuid_version = 4

field import_batch: ImportBatchRead | None = None

The parent import batch.

field reference_id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None

The ID of the reference created by this import result.

class libs.sdk.src.destiny_sdk.imports.ImportResultStatus(*values)

Describes the status of an import result.

COMPLETED = 'completed'

The reference has been created.

CREATED = 'created'

Created, but no processing has started.

FAILED = 'failed'

The reference failed to be created. See the result’s failure_details field for more information.

PARTIALLY_FAILED = 'partially_failed'

The reference was created but one or more enhancements or identifiers failed to be added. See the result’s failure_details field for more information.

RETRYING = 'retrying'

Processing has failed, but is being retried.

STARTED = 'started'

The reference is currently being processed.

Visibility

Visibility enum for repository data.

class libs.sdk.src.destiny_sdk.visibility.Visibility(*values)

The visibility of a data element in the repository.

This is used to manage whether information should be publicly available or restricted (generally due to copyright constraints from publishers).

HIDDEN = 'hidden'

Is not visible, but may be passed to data mining processes.

PUBLIC = 'public'

Visible to the general public without authentication.

RESTRICTED = 'restricted'

Requires authentication to be visible.

Robots

Schemas that define inputs/outputs for robots.

pydantic model libs.sdk.src.destiny_sdk.robots.EnhancementRequestIn

The model for requesting multiple enhancements on specific references.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "EnhancementRequestIn",
   "description": "The model for requesting multiple enhancements on specific references.",
   "type": "object",
   "properties": {
      "robot_id": {
         "description": "The robot to be used to create the enhancements.",
         "format": "uuid4",
         "title": "Robot Id",
         "type": "string"
      },
      "reference_ids": {
         "description": "The IDs of the references to be enhanced.",
         "items": {
            "format": "uuid4",
            "type": "string"
         },
         "title": "Reference Ids",
         "type": "array"
      },
      "source": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The source of the batch enhancement request.",
         "title": "Source"
      }
   },
   "required": [
      "robot_id",
      "reference_ids"
   ]
}

Fields:

• reference_ids (list[uuid.UUID])

• robot_id (uuid.UUID)

• source (str | None)

field reference_ids: list[UUID4] [Required]

The IDs of the references to be enhanced.

field robot_id: UUID4 [Required]

The robot to be used to create the enhancements.

Constraints:

• uuid_version = 4

field source: str | None = None

The source of the batch enhancement request.

pydantic model libs.sdk.src.destiny_sdk.robots.EnhancementRequestRead

Core batch enhancement request class.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "EnhancementRequestRead",
   "description": "Core batch enhancement request class.",
   "type": "object",
   "properties": {
      "robot_id": {
         "description": "The robot to be used to create the enhancements.",
         "format": "uuid4",
         "title": "Robot Id",
         "type": "string"
      },
      "reference_ids": {
         "description": "The IDs of the references to be enhanced.",
         "items": {
            "format": "uuid4",
            "type": "string"
         },
         "title": "Reference Ids",
         "type": "array"
      },
      "source": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The source of the batch enhancement request.",
         "title": "Source"
      },
      "id": {
         "format": "uuid4",
         "title": "Id",
         "type": "string"
      },
      "request_status": {
         "$ref": "#/$defs/EnhancementRequestStatus",
         "description": "The status of the request to create enhancements"
      },
      "reference_data_url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nThe URL at which the set of references are stored. The file is a jsonl with each line\nformatted according to\n:class:`Reference <libs.sdk.src.destiny_sdk.references.Reference>`.\n, one reference per line.\nEach reference may have identifiers or enhancements attached, as\nrequired by the robot.\nIf the URL expires, a new one can be generated using\n``GET /enhancement-requests/{request_id}/``.\n        ",
         "title": "Reference Data Url"
      },
      "result_storage_url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nThe URL at which the set of enhancements are stored. The file is to be a jsonl\nwith each line formatted according to\n:class:`EnhancementResultEntry <libs.sdk.src.destiny_sdk.robots.EnhancementResultEntry>`.\nThis field is only relevant to robots.\nIf the URL expires, a new one can be generated using\n``GET /enhancement-requests/{request_id}/``.\n        ",
         "title": "Result Storage Url"
      },
      "validation_result_url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nThe URL at which the result of the enhancement request is stored.\nThis file is a txt file, one line per reference, with either an error\nor a success message.\nIf the URL expires, a new one can be generated using\n``GET /enhancement-requests/{request_id}/``.\n        ",
         "title": "Validation Result Url"
      },
      "error": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Error encountered during the enhancement process. This is only used if the entire enhancement request failed, rather than an individual reference. If there was an error with processing an individual reference, it is passed in the validation result file.",
         "title": "Error"
      }
   },
   "$defs": {
      "EnhancementRequestStatus": {
         "description": "The status of an enhancement request.",
         "enum": [
            "received",
            "accepted",
            "processing",
            "rejected",
            "partial_failed",
            "failed",
            "importing",
            "indexing",
            "indexing_failed",
            "completed"
         ],
         "title": "EnhancementRequestStatus",
         "type": "string"
      }
   },
   "required": [
      "robot_id",
      "reference_ids",
      "id",
      "request_status"
   ]
}

Fields:

• error (str | None)

• id (uuid.UUID)

• reference_data_url (pydantic.networks.HttpUrl | None)

• reference_ids (list[uuid.UUID])

• request_status (libs.sdk.src.destiny_sdk.robots.EnhancementRequestStatus)

• result_storage_url (pydantic.networks.HttpUrl | None)

• robot_id (uuid.UUID)

• source (str | None)

• validation_result_url (pydantic.networks.HttpUrl | None)

field error: str | None = None

Error encountered during the enhancement process. This is only used if the entire enhancement request failed, rather than an individual reference. If there was an error with processing an individual reference, it is passed in the validation result file.

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

Constraints:

• uuid_version = 4

field reference_data_url: HttpUrl | None = None

The URL at which the set of references are stored. The file is a jsonl with each line formatted according to Reference. , one reference per line. Each reference may have identifiers or enhancements attached, as required by the robot. If the URL expires, a new one can be generated using GET /enhancement-requests/{request_id}/.

field reference_ids: list[UUID4] [Required]

The IDs of the references to be enhanced.

field request_status: EnhancementRequestStatus [Required]

The status of the request to create enhancements

field result_storage_url: HttpUrl | None = None

The URL at which the set of enhancements are stored. The file is to be a jsonl with each line formatted according to EnhancementResultEntry. This field is only relevant to robots. If the URL expires, a new one can be generated using GET /enhancement-requests/{request_id}/.

field robot_id: UUID4 [Required]

The robot to be used to create the enhancements.

Constraints:

• uuid_version = 4

field source: str | None = None

The source of the batch enhancement request.

field validation_result_url: HttpUrl | None = None

The URL at which the result of the enhancement request is stored. This file is a txt file, one line per reference, with either an error or a success message. If the URL expires, a new one can be generated using GET /enhancement-requests/{request_id}/.

class libs.sdk.src.destiny_sdk.robots.EnhancementRequestStatus(*values)

The status of an enhancement request.

ACCEPTED = 'accepted'

Enhancement request has been accepted by the robot.

COMPLETED = 'completed'

All enhancements have been created.

FAILED = 'failed'

All enhancements failed to create.

IMPORTING = 'importing'

Enhancements have been received by the repo and are being imported.

INDEXING = 'indexing'

Enhancements have been imported and are being indexed.

INDEXING_FAILED = 'indexing_failed'

Enhancements have been imported but indexing failed.

PARTIAL_FAILED = 'partial_failed'

Some enhancements failed to create.

PROCESSING = 'processing'

Enhancement request is being processed by the robot.

RECEIVED = 'received'

Enhancement request has been received by the repo.

REJECTED = 'rejected'

Enhancement request has been rejected by the robot.

libs.sdk.src.destiny_sdk.robots.EnhancementResultEntry

The result for a single reference when processed by an enhancement request. This is a single entry in the result file.

alias of Annotated[Enhancement | LinkedRobotError, FieldInfo(annotation=NoneType, required=True)]

pydantic model libs.sdk.src.destiny_sdk.robots.LinkedRobotError

A record of something going wrong when processing an individual reference.

Used in results for batch requests - in single requests, the reference id is derived from the request id.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "LinkedRobotError",
   "description": "A record of something going wrong when processing an individual reference.\n\nUsed in results for batch requests - in single requests, the reference\nid is derived from the request id.",
   "type": "object",
   "properties": {
      "message": {
         "description": "Message which describes the error encountered during processing",
         "title": "Message",
         "type": "string"
      },
      "reference_id": {
         "description": "The ID of the reference which caused the error.",
         "format": "uuid4",
         "title": "Reference Id",
         "type": "string"
      }
   },
   "required": [
      "message",
      "reference_id"
   ]
}

Fields:

• message (str)

• reference_id (uuid.UUID)

field message: Annotated[str, Field(description='Message which describes the error encountered during processing')] [Required]

Message which describes the error encountered during processing

field reference_id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the reference which caused the error.

Constraints:

• uuid_version = 4

classmethod from_jsonl(jsonl: str) → Self

Create an object from a JSONL string.

Parameters:

jsonl (str) – The JSONL string to parse.

Returns:

The created object.

Return type:

Self

to_jsonl() → str

Convert the model to a JSONL string.

Returns:

The JSONL string representation of the model.

Return type:

str

pydantic model libs.sdk.src.destiny_sdk.robots.ProvisionedRobot

The model for a provisioned robot.

Used only when a robot is initially created, or when cycling a robot’s client_secret.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "ProvisionedRobot",
   "description": "The model for a provisioned robot.\n\nUsed only when a robot is initially created,\nor when cycling a robot's client_secret.",
   "type": "object",
   "properties": {
      "name": {
         "description": "The name of the robot, must be unique.",
         "title": "Name",
         "type": "string"
      },
      "description": {
         "description": "Description of the enhancement the robot provides.",
         "title": "Description",
         "type": "string"
      },
      "owner": {
         "description": "The owner/publisher of the robot.",
         "title": "Owner",
         "type": "string"
      },
      "id": {
         "description": "The id of the robot provided by destiny repository. Used as the client_id when sending HMAC authenticated requests.",
         "format": "uuid4",
         "title": "Id",
         "type": "string"
      },
      "client_secret": {
         "description": "The client secret of the robot, used as the secret key when sending HMAC authenticated requests.",
         "title": "Client Secret",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "description",
      "owner",
      "id",
      "client_secret"
   ]
}

Config:

• extra: str = forbid

Fields:

• client_secret (str)

• description (str)

• id (uuid.UUID)

• name (str)

• owner (str)

field client_secret: str [Required]

The client secret of the robot, used as the secret key when sending HMAC authenticated requests.

field description: str [Required]

Description of the enhancement the robot provides.

field id: UUID4 [Required]

The id of the robot provided by destiny repository. Used as the client_id when sending HMAC authenticated requests.

Constraints:

• uuid_version = 4

field name: str [Required]

The name of the robot, must be unique.

field owner: str [Required]

The owner/publisher of the robot.

pydantic model libs.sdk.src.destiny_sdk.robots.Robot

Then model for a registered robot.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "Robot",
   "description": "Then model for a registered robot.",
   "type": "object",
   "properties": {
      "name": {
         "description": "The name of the robot, must be unique.",
         "title": "Name",
         "type": "string"
      },
      "description": {
         "description": "Description of the enhancement the robot provides.",
         "title": "Description",
         "type": "string"
      },
      "owner": {
         "description": "The owner/publisher of the robot.",
         "title": "Owner",
         "type": "string"
      },
      "id": {
         "description": "The id of the robot provided by destiny repository. Used as the client_id when sending HMAC authenticated requests.",
         "format": "uuid4",
         "title": "Id",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "description",
      "owner",
      "id"
   ]
}

Config:

• extra: str = forbid

Fields:

• description (str)

• id (uuid.UUID)

• name (str)

• owner (str)

field description: str [Required]

Description of the enhancement the robot provides.

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The id of the robot provided by destiny repository. Used as the client_id when sending HMAC authenticated requests.

Constraints:

• uuid_version = 4

field name: str [Required]

The name of the robot, must be unique.

field owner: str [Required]

The owner/publisher of the robot.

pydantic model libs.sdk.src.destiny_sdk.robots.RobotAutomation

Core Robot Automation class.

This is used as a source of truth for an Elasticsearch index that percolates references or enhancements against the queries. If a query matches, a request is sent to the specified robot to perform the enhancement.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotAutomation",
   "description": "Core Robot Automation class.\n\nThis is used as a source of truth for an Elasticsearch index that percolates\nreferences or enhancements against the queries. If a query matches, a request\nis sent to the specified robot to perform the enhancement.",
   "type": "object",
   "properties": {
      "robot_id": {
         "description": "The ID of the robot that will be used to enhance the reference.",
         "format": "uuid4",
         "title": "Robot Id",
         "type": "string"
      },
      "query": {
         "additionalProperties": true,
         "description": "The percolator query that will be used to match references  or enhancements against.",
         "title": "Query",
         "type": "object"
      },
      "id": {
         "description": "The ID of the robot automation.",
         "format": "uuid4",
         "title": "Id",
         "type": "string"
      }
   },
   "required": [
      "robot_id",
      "query",
      "id"
   ]
}

Fields:

• id (uuid.UUID)

• query (dict[str, Any])

• robot_id (uuid.UUID)

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the robot automation.

Constraints:

• uuid_version = 4

field query: dict[str, Any] [Required]

The percolator query that will be used to match references or enhancements against.

field robot_id: UUID4 [Required]

The ID of the robot that will be used to enhance the reference.

Constraints:

• uuid_version = 4

pydantic model libs.sdk.src.destiny_sdk.robots.RobotAutomationIn

Automation model for a robot.

This is used as a source of truth for an Elasticsearch index that percolates references or enhancements against the queries. If a query matches, a request is sent to the specified robot to perform the enhancement.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotAutomationIn",
   "description": "Automation model for a robot.\n\nThis is used as a source of truth for an Elasticsearch index that percolates\nreferences or enhancements against the queries. If a query matches, a request\nis sent to the specified robot to perform the enhancement.",
   "type": "object",
   "properties": {
      "robot_id": {
         "description": "The ID of the robot that will be used to enhance the reference.",
         "format": "uuid4",
         "title": "Robot Id",
         "type": "string"
      },
      "query": {
         "additionalProperties": true,
         "description": "The percolator query that will be used to match references  or enhancements against.",
         "title": "Query",
         "type": "object"
      }
   },
   "required": [
      "robot_id",
      "query"
   ]
}

Fields:

• query (dict[str, Any])

• robot_id (uuid.UUID)

field query: dict[str, Any] [Required]

The percolator query that will be used to match references or enhancements against.

field robot_id: UUID4 [Required]

The ID of the robot that will be used to enhance the reference.

Constraints:

• uuid_version = 4

pydantic model libs.sdk.src.destiny_sdk.robots.RobotEnhancementBatch

A robot enhancement batch from the repo to a robot.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotEnhancementBatch",
   "description": "A robot enhancement batch from the repo to a robot.",
   "type": "object",
   "properties": {
      "id": {
         "format": "uuid4",
         "title": "Id",
         "type": "string"
      },
      "reference_storage_url": {
         "description": "\nThe URL at which the set of references are stored. The file is a jsonl\nwith each line formatted according to\n:class:`Reference <libs.sdk.src.destiny_sdk.references.Reference>`, one\nreference per line.\nEach reference may have identifiers or enhancements attached, as\nrequired by the robot.\nIf the URL expires, a new one can be generated using\n``GET /robot-enhancement-batches/{batch_id}/``.\n",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "Reference Storage Url",
         "type": "string"
      },
      "result_storage_url": {
         "description": "\nThe URL at which the set of enhancements are to be stored. The file is to be a jsonl\nwith each line formatted according to\n:class:`EnhancementResultEntry <libs.sdk.src.destiny_sdk.robots.EnhancementResultEntry>`.\nIf the URL expires, a new one can be generated using\n``GET /robot-enhancement-batches/{batch_id}/``.\n",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "Result Storage Url",
         "type": "string"
      },
      "extra_fields": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Extra fields to pass to the robot. TBC.",
         "title": "Extra Fields"
      }
   },
   "required": [
      "id",
      "reference_storage_url",
      "result_storage_url"
   ]
}

Fields:

• extra_fields (dict | None)

• id (uuid.UUID)

• reference_storage_url (pydantic.networks.HttpUrl)

• result_storage_url (pydantic.networks.HttpUrl)

field extra_fields: dict | None = None

Extra fields to pass to the robot. TBC.

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

Constraints:

• uuid_version = 4

field reference_storage_url: HttpUrl [Required]

The URL at which the set of references are stored. The file is a jsonl with each line formatted according to Reference, one reference per line. Each reference may have identifiers or enhancements attached, as required by the robot. If the URL expires, a new one can be generated using GET /robot-enhancement-batches/{batch_id}/.

field result_storage_url: HttpUrl [Required]

The URL at which the set of enhancements are to be stored. The file is to be a jsonl with each line formatted according to EnhancementResultEntry. If the URL expires, a new one can be generated using GET /robot-enhancement-batches/{batch_id}/.

pydantic model libs.sdk.src.destiny_sdk.robots.RobotEnhancementBatchRead

Core robot enhancement batch class.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotEnhancementBatchRead",
   "description": "Core robot enhancement batch class.",
   "type": "object",
   "properties": {
      "robot_id": {
         "description": "The robot to be used to create the enhancements.",
         "format": "uuid4",
         "title": "Robot Id",
         "type": "string"
      },
      "source": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The source of the batch enhancement request.",
         "title": "Source"
      },
      "id": {
         "format": "uuid4",
         "title": "Id",
         "type": "string"
      },
      "reference_data_url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nThe URL at which the set of references are stored. The file is a jsonl with each line\nformatted according to\n:class:`Reference <libs.sdk.src.destiny_sdk.references.Reference>`.\n, one reference per line.\nEach reference may have identifiers or enhancements attached, as\nrequired by the robot.\nIf the URL expires, a new one can be generated using\n``GET /enhancement-requests/{request_id}/``.\n        ",
         "title": "Reference Data Url"
      },
      "result_storage_url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nThe URL at which the set of enhancements are stored. The file is to be a jsonl\nwith each line formatted according to\n:class:`EnhancementResultEntry <libs.sdk.src.destiny_sdk.robots.EnhancementResultEntry>`.\nThis field is only relevant to robots.\nIf the URL expires, a new one can be generated using\n``GET /robot-enhancement-batches/{batch_id}/``.\n        ",
         "title": "Result Storage Url"
      },
      "validation_result_url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nThe URL at which the result of the enhancement request is stored.\nThis file is a txt file, one line per reference, with either an error\nor a success message.\nIf the URL expires, a new one can be generated using\n``GET /robot-enhancement-batches/{batch_id}/``.\n        ",
         "title": "Validation Result Url"
      },
      "error": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Error encountered during the enhancement process. This is only used if the entire enhancement batch failed, rather than an individual reference. If there was an error with processing an individual reference, it is passed in the validation result file.",
         "title": "Error"
      }
   },
   "required": [
      "robot_id",
      "id"
   ]
}

Fields:

• error (str | None)

• id (uuid.UUID)

• reference_data_url (pydantic.networks.HttpUrl | None)

• result_storage_url (pydantic.networks.HttpUrl | None)

• robot_id (uuid.UUID)

• source (str | None)

• validation_result_url (pydantic.networks.HttpUrl | None)

field error: str | None = None

Error encountered during the enhancement process. This is only used if the entire enhancement batch failed, rather than an individual reference. If there was an error with processing an individual reference, it is passed in the validation result file.

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

Constraints:

• uuid_version = 4

field reference_data_url: HttpUrl | None = None

The URL at which the set of references are stored. The file is a jsonl with each line formatted according to Reference. , one reference per line. Each reference may have identifiers or enhancements attached, as required by the robot. If the URL expires, a new one can be generated using GET /enhancement-requests/{request_id}/.

field result_storage_url: HttpUrl | None = None

The URL at which the set of enhancements are stored. The file is to be a jsonl with each line formatted according to EnhancementResultEntry. This field is only relevant to robots. If the URL expires, a new one can be generated using GET /robot-enhancement-batches/{batch_id}/.

field robot_id: UUID4 [Required]

The robot to be used to create the enhancements.

Constraints:

• uuid_version = 4

field source: str | None = None

The source of the batch enhancement request.

field validation_result_url: HttpUrl | None = None

The URL at which the result of the enhancement request is stored. This file is a txt file, one line per reference, with either an error or a success message. If the URL expires, a new one can be generated using GET /robot-enhancement-batches/{batch_id}/.

pydantic model libs.sdk.src.destiny_sdk.robots.RobotEnhancementBatchResult

Used to indicate that the robot has finished processing a batch.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotEnhancementBatchResult",
   "description": "Used to indicate that the robot has finished processing a batch.",
   "type": "object",
   "properties": {
      "request_id": {
         "format": "uuid4",
         "title": "Request Id",
         "type": "string"
      },
      "error": {
         "anyOf": [
            {
               "$ref": "#/$defs/RobotError"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nError the robot encountered while creating enhancements. If this field is populated,\nwe assume the entire robot enhancement batch failed,\nrather than an individual reference.\nIf there was an error with processing an individual reference, it should be passed in\nthe result file and this field should be left as None. Vice-versa, if this field is\nNone, the repository will assume that the result file is ready for processing.\n"
      }
   },
   "$defs": {
      "RobotError": {
         "description": "A record of something going wrong with the robot.",
         "properties": {
            "message": {
               "description": "Message which describes the error encountered during processing",
               "title": "Message",
               "type": "string"
            }
         },
         "required": [
            "message"
         ],
         "title": "RobotError",
         "type": "object"
      }
   },
   "required": [
      "request_id"
   ]
}

Fields:

• error (libs.sdk.src.destiny_sdk.robots.RobotError | None)

• request_id (uuid.UUID)

field error: RobotError | None = None

Error the robot encountered while creating enhancements. If this field is populated, we assume the entire robot enhancement batch failed, rather than an individual reference. If there was an error with processing an individual reference, it should be passed in the result file and this field should be left as None. Vice-versa, if this field is None, the repository will assume that the result file is ready for processing.

field request_id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

Constraints:

• uuid_version = 4

pydantic model libs.sdk.src.destiny_sdk.robots.RobotError

A record of something going wrong with the robot.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotError",
   "description": "A record of something going wrong with the robot.",
   "type": "object",
   "properties": {
      "message": {
         "description": "Message which describes the error encountered during processing",
         "title": "Message",
         "type": "string"
      }
   },
   "required": [
      "message"
   ]
}

Fields:

• message (str)

field message: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Message which describes the error encountered during processing')] [Required]

Message which describes the error encountered during processing

pydantic model libs.sdk.src.destiny_sdk.robots.RobotIn

The model for registering a new robot.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotIn",
   "description": "The model for registering a new robot.",
   "type": "object",
   "properties": {
      "name": {
         "description": "The name of the robot, must be unique.",
         "title": "Name",
         "type": "string"
      },
      "description": {
         "description": "Description of the enhancement the robot provides.",
         "title": "Description",
         "type": "string"
      },
      "owner": {
         "description": "The owner/publisher of the robot.",
         "title": "Owner",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "description",
      "owner"
   ]
}

Config:

• extra: str = forbid

Fields:

• description (str)

• name (str)

• owner (str)

field description: str [Required]

Description of the enhancement the robot provides.

field name: str [Required]

The name of the robot, must be unique.

field owner: str [Required]

The owner/publisher of the robot.

pydantic model libs.sdk.src.destiny_sdk.robots.RobotRequest

A batch enhancement request from the repo to a robot.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotRequest",
   "description": "A batch enhancement request from the repo to a robot.",
   "type": "object",
   "properties": {
      "id": {
         "format": "uuid4",
         "title": "Id",
         "type": "string"
      },
      "reference_storage_url": {
         "description": "\nThe URL at which the set of references are stored. The file is a jsonl\nwith each line formatted according to\n:class:`Reference <libs.sdk.src.destiny_sdk.references.Reference>`, one\nreference per line.\nEach reference may have identifiers or enhancements attached, as\nrequired by the robot.\nIf the URL expires, a new one can be generated using\n``GET /enhancement-requests/{request_id}/``.\n",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "Reference Storage Url",
         "type": "string"
      },
      "result_storage_url": {
         "description": "\nThe URL at which the set of enhancements are to be stored. The file is to be a jsonl\nwith each line formatted according to\n:class:`EnhancementResultEntry <libs.sdk.src.destiny_sdk.robots.EnhancementResultEntry>`.\nIf the URL expires, a new one can be generated using\n``GET /enhancement-requests/{request_id}/``.\n",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "Result Storage Url",
         "type": "string"
      },
      "extra_fields": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Extra fields to pass to the robot. TBC.",
         "title": "Extra Fields"
      }
   },
   "required": [
      "id",
      "reference_storage_url",
      "result_storage_url"
   ]
}

Fields:

• extra_fields (dict | None)

• id (uuid.UUID)

• reference_storage_url (pydantic.networks.HttpUrl)

• result_storage_url (pydantic.networks.HttpUrl)

field extra_fields: dict | None = None

Extra fields to pass to the robot. TBC.

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

Constraints:

• uuid_version = 4

field reference_storage_url: HttpUrl [Required]

The URL at which the set of references are stored. The file is a jsonl with each line formatted according to Reference, one reference per line. Each reference may have identifiers or enhancements attached, as required by the robot. If the URL expires, a new one can be generated using GET /enhancement-requests/{request_id}/.

field result_storage_url: HttpUrl [Required]

The URL at which the set of enhancements are to be stored. The file is to be a jsonl with each line formatted according to EnhancementResultEntry. If the URL expires, a new one can be generated using GET /enhancement-requests/{request_id}/.

pydantic model libs.sdk.src.destiny_sdk.robots.RobotResult

Used to indicate to the repository that the robot has finished processing.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotResult",
   "description": "Used to indicate to the repository that the robot has finished processing.",
   "type": "object",
   "properties": {
      "request_id": {
         "format": "uuid4",
         "title": "Request Id",
         "type": "string"
      },
      "error": {
         "anyOf": [
            {
               "$ref": "#/$defs/RobotError"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nError the robot encountered while creating enhancements. If this field is populated,\nwe assume the entire enhancement request or http request request failed,\nrather than an individual reference.\nIf there was an error with processing an individual reference, it should be passed in\nthe result file and this field should be left as None. Vice-versa, if this field is\nNone, the repository will assume that the result file is ready for processing.\n"
      }
   },
   "$defs": {
      "RobotError": {
         "description": "A record of something going wrong with the robot.",
         "properties": {
            "message": {
               "description": "Message which describes the error encountered during processing",
               "title": "Message",
               "type": "string"
            }
         },
         "required": [
            "message"
         ],
         "title": "RobotError",
         "type": "object"
      }
   },
   "required": [
      "request_id"
   ]
}

Fields:

• error (libs.sdk.src.destiny_sdk.robots.RobotError | None)

• request_id (uuid.UUID)

field error: RobotError | None = None

Error the robot encountered while creating enhancements. If this field is populated, we assume the entire enhancement request or http request request failed, rather than an individual reference. If there was an error with processing an individual reference, it should be passed in the result file and this field should be left as None. Vice-versa, if this field is None, the repository will assume that the result file is ready for processing.

field request_id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

Constraints:

• uuid_version = 4

pydantic model libs.sdk.src.destiny_sdk.robots.RobotResultValidationEntry

A single entry in the validation result file for a batch enhancement request.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "RobotResultValidationEntry",
   "description": "A single entry in the validation result file for a batch enhancement request.",
   "type": "object",
   "properties": {
      "reference_id": {
         "anyOf": [
            {
               "format": "uuid4",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ID of the reference which was enhanced. If this is empty, the EnhancementResultEntry could not be parsed.",
         "title": "Reference Id"
      },
      "error": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Error encountered during the enhancement process for this reference. If this is empty, the enhancement was successfully created.",
         "title": "Error"
      }
   }
}

Fields:

• error (str | None)

• reference_id (uuid.UUID | None)

field error: str | None = None

Error encountered during the enhancement process for this reference. If this is empty, the enhancement was successfully created.

field reference_id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None

The ID of the reference which was enhanced. If this is empty, the EnhancementResultEntry could not be parsed.

classmethod from_jsonl(jsonl: str) → Self

Create an object from a JSONL string.

Parameters:

jsonl (str) – The JSONL string to parse.

Returns:

The created object.

Return type:

Self

to_jsonl() → str

Convert the model to a JSONL string.

Returns:

The JSONL string representation of the model.

Return type:

str

Enhancements

Enhancement classes for the Destiny Repository.

pydantic model libs.sdk.src.destiny_sdk.enhancements.AbstractContentEnhancement

An enhancement which is specific to the abstract of a reference.

This is separate from the BibliographicMetadata for two reasons:

1. Abstracts are increasingly missing from sources like OpenAlex, and may be backfilled from other sources, without the bibliographic metadata. 2. They are also subject to copyright limitations in ways which metadata are not, and thus need separate visibility controls.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "AbstractContentEnhancement",
   "description": "An enhancement which is specific to the abstract of a reference.\n\nThis is separate from the `BibliographicMetadata` for two reasons:\n\n1. Abstracts are increasingly missing from sources like OpenAlex, and may be\nbackfilled from other sources, without the bibliographic metadata.\n2. They are also subject to copyright limitations in ways which metadata are\nnot, and thus need separate visibility controls.",
   "type": "object",
   "properties": {
      "enhancement_type": {
         "const": "abstract",
         "default": "abstract",
         "title": "Enhancement Type",
         "type": "string"
      },
      "process": {
         "$ref": "#/$defs/AbstractProcessType"
      },
      "abstract": {
         "description": "The abstract of the reference.",
         "title": "Abstract",
         "type": "string"
      }
   },
   "$defs": {
      "AbstractProcessType": {
         "description": "The process used to acquire the abstract.",
         "enum": [
            "uninverted",
            "closed_api",
            "other"
         ],
         "title": "AbstractProcessType",
         "type": "string"
      }
   },
   "required": [
      "process",
      "abstract"
   ]
}

Fields:

• abstract (str)

• enhancement_type (Literal[libs.sdk.src.destiny_sdk.enhancements.EnhancementType.ABSTRACT])

• process (libs.sdk.src.destiny_sdk.enhancements.AbstractProcessType)

field abstract: str [Required]

The abstract of the reference.

field enhancement_type: Literal[EnhancementType.ABSTRACT] = EnhancementType.ABSTRACT

field process: AbstractProcessType [Required]

The process used to acquire the abstract.

class libs.sdk.src.destiny_sdk.enhancements.AbstractProcessType(*values)

The process used to acquire the abstract.

CLOSED_API = 'closed_api'

closed_api

OTHER = 'other'

other

UNINVERTED = 'uninverted'

uninverted

libs.sdk.src.destiny_sdk.enhancements.Annotation

Union type for all annotations.

alias of Annotated[BooleanAnnotation | ScoreAnnotation, FieldInfo(annotation=NoneType, required=True, discriminator=’annotation_type’)]

pydantic model libs.sdk.src.destiny_sdk.enhancements.AnnotationEnhancement

An enhancement which is composed of a list of Annotations.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "AnnotationEnhancement",
   "description": "An enhancement which is composed of a list of Annotations.",
   "type": "object",
   "properties": {
      "enhancement_type": {
         "const": "annotation",
         "default": "annotation",
         "title": "Enhancement Type",
         "type": "string"
      },
      "annotations": {
         "items": {
            "discriminator": {
               "mapping": {
                  "boolean": "#/$defs/BooleanAnnotation",
                  "score": "#/$defs/ScoreAnnotation"
               },
               "propertyName": "annotation_type"
            },
            "oneOf": [
               {
                  "$ref": "#/$defs/BooleanAnnotation"
               },
               {
                  "$ref": "#/$defs/ScoreAnnotation"
               }
            ]
         },
         "minItems": 1,
         "title": "Annotations",
         "type": "array"
      }
   },
   "$defs": {
      "BooleanAnnotation": {
         "description": "An annotation is a way of tagging the content with a label of some kind.\n\nThis class will probably be broken up in the future, but covers most of our\ninitial cases.",
         "properties": {
            "annotation_type": {
               "const": "boolean",
               "default": "boolean",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of the annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "value": {
               "description": "Boolean flag for this annotation",
               "title": "Value",
               "type": "boolean"
            },
            "score": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A confidence score for this annotation",
               "title": "Score"
            },
            "data": {
               "additionalProperties": true,
               "description": "\nAn object representation of the annotation including any confidence scores or\ndescriptions.\n",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "value"
         ],
         "title": "BooleanAnnotation",
         "type": "object"
      },
      "ScoreAnnotation": {
         "description": "An annotation which represents the score for a label.\n\nThis is similar to a BooleanAnnotation, but lacks a boolean determination\nas to the application of the label.",
         "properties": {
            "annotation_type": {
               "const": "score",
               "default": "score",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "score": {
               "description": "Score for this annotation",
               "title": "Score",
               "type": "number"
            },
            "data": {
               "additionalProperties": true,
               "description": "An object representation of the annotation including any confidence scores or descriptions.",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "score"
         ],
         "title": "ScoreAnnotation",
         "type": "object"
      }
   },
   "required": [
      "annotations"
   ]
}

Fields:

• annotations (list[libs.sdk.src.destiny_sdk.enhancements.BooleanAnnotation | libs.sdk.src.destiny_sdk.enhancements.ScoreAnnotation])

• enhancement_type (Literal[libs.sdk.src.destiny_sdk.enhancements.EnhancementType.ANNOTATION])

field annotations: list[Annotated[BooleanAnnotation | ScoreAnnotation, FieldInfo(annotation=NoneType, required=True, discriminator='annotation_type')]] [Required]

Constraints:

• min_length = 1

field enhancement_type: Literal[EnhancementType.ANNOTATION] = EnhancementType.ANNOTATION

class libs.sdk.src.destiny_sdk.enhancements.AnnotationType(*values)

The type of annotation.

This is used to identify the type of annotation in the Annotation class.

BOOLEAN = 'boolean'

An annotation which is the boolean application of a label across a reference.

SCORE = 'score'

An annotation which is a score for a label across a reference, without a boolean value.

class libs.sdk.src.destiny_sdk.enhancements.AuthorPosition(*values)

The position of an author in a list of authorships.

Maps to the data from OpenAlex.

FIRST = 'first'

The first author.

LAST = 'last'

The last author.

MIDDLE = 'middle'

Any middle author.

pydantic model libs.sdk.src.destiny_sdk.enhancements.Authorship

Represents a single author and their association with a reference.

This is a simplification of the OpenAlex [Authorship object](https://docs.openalex.org/api-entities/works/work-object/authorship-object) for our purposes.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "Authorship",
   "description": "Represents a single author and their association with a reference.\n\nThis is a simplification of the OpenAlex [Authorship\nobject](https://docs.openalex.org/api-entities/works/work-object/authorship-object)\nfor our purposes.",
   "type": "object",
   "properties": {
      "display_name": {
         "description": "The display name of the author.",
         "title": "Display Name",
         "type": "string"
      },
      "orcid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ORCid of the author.",
         "title": "Orcid"
      },
      "position": {
         "$ref": "#/$defs/AuthorPosition",
         "description": "The position of the author within the list of authors."
      }
   },
   "$defs": {
      "AuthorPosition": {
         "description": "The position of an author in a list of authorships.\n\nMaps to the data from OpenAlex.",
         "enum": [
            "first",
            "middle",
            "last"
         ],
         "title": "AuthorPosition",
         "type": "string"
      }
   },
   "required": [
      "display_name",
      "position"
   ]
}

Fields:

• display_name (str)

• orcid (str | None)

• position (libs.sdk.src.destiny_sdk.enhancements.AuthorPosition)

field display_name: str [Required]

The display name of the author.

field orcid: str | None = None

The ORCid of the author.

field position: AuthorPosition [Required]

The position of the author within the list of authors.

pydantic model libs.sdk.src.destiny_sdk.enhancements.BibliographicMetadataEnhancement

An enhancement which is made up of bibliographic metadata.

Generally this will be sourced from a database such as OpenAlex or similar. For directly contributed references, these may not be complete.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "BibliographicMetadataEnhancement",
   "description": "An enhancement which is made up of bibliographic metadata.\n\nGenerally this will be sourced from a database such as OpenAlex or similar.\nFor directly contributed references, these may not be complete.",
   "type": "object",
   "properties": {
      "enhancement_type": {
         "const": "bibliographic",
         "default": "bibliographic",
         "title": "Enhancement Type",
         "type": "string"
      },
      "authorship": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Authorship"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A list of `Authorships` belonging to this reference.",
         "title": "Authorship"
      },
      "cited_by_count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\n(From OpenAlex) The number of citations to this work. These are the times that\nother works have cited this work\n",
         "title": "Cited By Count"
      },
      "created_date": {
         "anyOf": [
            {
               "format": "date",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ISO8601 date this metadata record was created",
         "title": "Created Date"
      },
      "publication_date": {
         "anyOf": [
            {
               "format": "date",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The date which the version of record was published.",
         "title": "Publication Date"
      },
      "publication_year": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The year in which the version of record was published.",
         "title": "Publication Year"
      },
      "publisher": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The name of the entity which published the version of record.",
         "title": "Publisher"
      },
      "title": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The title of the reference.",
         "title": "Title"
      }
   },
   "$defs": {
      "AuthorPosition": {
         "description": "The position of an author in a list of authorships.\n\nMaps to the data from OpenAlex.",
         "enum": [
            "first",
            "middle",
            "last"
         ],
         "title": "AuthorPosition",
         "type": "string"
      },
      "Authorship": {
         "description": "Represents a single author and their association with a reference.\n\nThis is a simplification of the OpenAlex [Authorship\nobject](https://docs.openalex.org/api-entities/works/work-object/authorship-object)\nfor our purposes.",
         "properties": {
            "display_name": {
               "description": "The display name of the author.",
               "title": "Display Name",
               "type": "string"
            },
            "orcid": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ORCid of the author.",
               "title": "Orcid"
            },
            "position": {
               "$ref": "#/$defs/AuthorPosition",
               "description": "The position of the author within the list of authors."
            }
         },
         "required": [
            "display_name",
            "position"
         ],
         "title": "Authorship",
         "type": "object"
      }
   }
}

Fields:

• authorship (list[libs.sdk.src.destiny_sdk.enhancements.Authorship] | None)

• cited_by_count (int | None)

• created_date (datetime.date | None)

• enhancement_type (Literal[libs.sdk.src.destiny_sdk.enhancements.EnhancementType.BIBLIOGRAPHIC])

• publication_date (datetime.date | None)

• publication_year (int | None)

• publisher (str | None)

• title (str | None)

field authorship: list[Authorship] | None = None

A list of Authorships belonging to this reference.

field cited_by_count: int | None = None

(From OpenAlex) The number of citations to this work. These are the times that other works have cited this work

field created_date: date | None = None

The ISO8601 date this metadata record was created

field enhancement_type: Literal[EnhancementType.BIBLIOGRAPHIC] = EnhancementType.BIBLIOGRAPHIC

field publication_date: date | None = None

The date which the version of record was published.

field publication_year: int | None = None

The year in which the version of record was published.

field publisher: str | None = None

The name of the entity which published the version of record.

field title: str | None = None

The title of the reference.

pydantic model libs.sdk.src.destiny_sdk.enhancements.BooleanAnnotation

An annotation is a way of tagging the content with a label of some kind.

This class will probably be broken up in the future, but covers most of our initial cases.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "BooleanAnnotation",
   "description": "An annotation is a way of tagging the content with a label of some kind.\n\nThis class will probably be broken up in the future, but covers most of our\ninitial cases.",
   "type": "object",
   "properties": {
      "annotation_type": {
         "const": "boolean",
         "default": "boolean",
         "title": "Annotation Type",
         "type": "string"
      },
      "scheme": {
         "description": "An identifier for the scheme of the annotation",
         "examples": [
            "openalex:topic",
            "pubmed:mesh"
         ],
         "title": "Scheme",
         "type": "string"
      },
      "label": {
         "description": "A high level label for this annotation like the name of the topic",
         "title": "Label",
         "type": "string"
      },
      "value": {
         "description": "Boolean flag for this annotation",
         "title": "Value",
         "type": "boolean"
      },
      "score": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A confidence score for this annotation",
         "title": "Score"
      },
      "data": {
         "additionalProperties": true,
         "description": "\nAn object representation of the annotation including any confidence scores or\ndescriptions.\n",
         "title": "Data",
         "type": "object"
      }
   },
   "required": [
      "scheme",
      "label",
      "value"
   ]
}

Fields:

• annotation_type (Literal[libs.sdk.src.destiny_sdk.enhancements.AnnotationType.BOOLEAN])

• data (dict)

• label (str)

• scheme (str)

• score (float | None)

• value (bool)

field annotation_type: Literal[AnnotationType.BOOLEAN] = AnnotationType.BOOLEAN

field data: dict [Optional]

An object representation of the annotation including any confidence scores or descriptions.

field label: str [Required]

A high level label for this annotation like the name of the topic

field scheme: str [Required]

An identifier for the scheme of the annotation

field score: float | None = None

A confidence score for this annotation

field value: bool [Required]

Boolean flag for this annotation

class libs.sdk.src.destiny_sdk.enhancements.DriverVersion(*values)

The version based on the DRIVER guidelines versioning scheme.

(Borrowed from OpenAlex)

ACCEPTED_VERSION = 'acceptedVersion'

The document after having completed peer review and being officially accepted for publication. It will lack publisher formatting, but the content should be interchangeable with that of the publishedVersion.

OTHER = 'other'

Other version.

PUBLISHED_VERSION = 'publishedVersion'

The document’s version of record. This is the most authoritative version.

SUBMITTED_VERSION = 'submittedVersion'

The document as submitted to the publisher by the authors, but before peer-review. Its content may differ significantly from that of the accepted article.

pydantic model libs.sdk.src.destiny_sdk.enhancements.Enhancement

Core enhancement class.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "Enhancement",
   "description": "Core enhancement class.",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "format": "uuid4",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ID of the enhancement. Populated by the repository when sending enhancements with references.",
         "title": "Id"
      },
      "reference_id": {
         "description": "The ID of the reference this enhancement is associated with.",
         "format": "uuid4",
         "title": "Reference Id",
         "type": "string"
      },
      "source": {
         "description": "The enhancement source for tracking provenance.",
         "title": "Source",
         "type": "string"
      },
      "visibility": {
         "$ref": "#/$defs/Visibility",
         "description": "The level of visibility of the enhancement"
      },
      "robot_version": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The version of the robot that generated the content.",
         "title": "Robot Version"
      },
      "derived_from": {
         "anyOf": [
            {
               "items": {
                  "format": "uuid4",
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "List of enhancement IDs that this enhancement was derived from.",
         "title": "Derived From"
      },
      "content": {
         "description": "The content of the enhancement.",
         "discriminator": {
            "mapping": {
               "abstract": "#/$defs/AbstractContentEnhancement",
               "annotation": "#/$defs/AnnotationEnhancement",
               "bibliographic": "#/$defs/BibliographicMetadataEnhancement",
               "location": "#/$defs/LocationEnhancement"
            },
            "propertyName": "enhancement_type"
         },
         "oneOf": [
            {
               "$ref": "#/$defs/BibliographicMetadataEnhancement"
            },
            {
               "$ref": "#/$defs/AbstractContentEnhancement"
            },
            {
               "$ref": "#/$defs/AnnotationEnhancement"
            },
            {
               "$ref": "#/$defs/LocationEnhancement"
            }
         ],
         "title": "Content"
      }
   },
   "$defs": {
      "AbstractContentEnhancement": {
         "description": "An enhancement which is specific to the abstract of a reference.\n\nThis is separate from the `BibliographicMetadata` for two reasons:\n\n1. Abstracts are increasingly missing from sources like OpenAlex, and may be\nbackfilled from other sources, without the bibliographic metadata.\n2. They are also subject to copyright limitations in ways which metadata are\nnot, and thus need separate visibility controls.",
         "properties": {
            "enhancement_type": {
               "const": "abstract",
               "default": "abstract",
               "title": "Enhancement Type",
               "type": "string"
            },
            "process": {
               "$ref": "#/$defs/AbstractProcessType"
            },
            "abstract": {
               "description": "The abstract of the reference.",
               "title": "Abstract",
               "type": "string"
            }
         },
         "required": [
            "process",
            "abstract"
         ],
         "title": "AbstractContentEnhancement",
         "type": "object"
      },
      "AbstractProcessType": {
         "description": "The process used to acquire the abstract.",
         "enum": [
            "uninverted",
            "closed_api",
            "other"
         ],
         "title": "AbstractProcessType",
         "type": "string"
      },
      "AnnotationEnhancement": {
         "description": "An enhancement which is composed of a list of Annotations.",
         "properties": {
            "enhancement_type": {
               "const": "annotation",
               "default": "annotation",
               "title": "Enhancement Type",
               "type": "string"
            },
            "annotations": {
               "items": {
                  "discriminator": {
                     "mapping": {
                        "boolean": "#/$defs/BooleanAnnotation",
                        "score": "#/$defs/ScoreAnnotation"
                     },
                     "propertyName": "annotation_type"
                  },
                  "oneOf": [
                     {
                        "$ref": "#/$defs/BooleanAnnotation"
                     },
                     {
                        "$ref": "#/$defs/ScoreAnnotation"
                     }
                  ]
               },
               "minItems": 1,
               "title": "Annotations",
               "type": "array"
            }
         },
         "required": [
            "annotations"
         ],
         "title": "AnnotationEnhancement",
         "type": "object"
      },
      "AuthorPosition": {
         "description": "The position of an author in a list of authorships.\n\nMaps to the data from OpenAlex.",
         "enum": [
            "first",
            "middle",
            "last"
         ],
         "title": "AuthorPosition",
         "type": "string"
      },
      "Authorship": {
         "description": "Represents a single author and their association with a reference.\n\nThis is a simplification of the OpenAlex [Authorship\nobject](https://docs.openalex.org/api-entities/works/work-object/authorship-object)\nfor our purposes.",
         "properties": {
            "display_name": {
               "description": "The display name of the author.",
               "title": "Display Name",
               "type": "string"
            },
            "orcid": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ORCid of the author.",
               "title": "Orcid"
            },
            "position": {
               "$ref": "#/$defs/AuthorPosition",
               "description": "The position of the author within the list of authors."
            }
         },
         "required": [
            "display_name",
            "position"
         ],
         "title": "Authorship",
         "type": "object"
      },
      "BibliographicMetadataEnhancement": {
         "description": "An enhancement which is made up of bibliographic metadata.\n\nGenerally this will be sourced from a database such as OpenAlex or similar.\nFor directly contributed references, these may not be complete.",
         "properties": {
            "enhancement_type": {
               "const": "bibliographic",
               "default": "bibliographic",
               "title": "Enhancement Type",
               "type": "string"
            },
            "authorship": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Authorship"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of `Authorships` belonging to this reference.",
               "title": "Authorship"
            },
            "cited_by_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex) The number of citations to this work. These are the times that\nother works have cited this work\n",
               "title": "Cited By Count"
            },
            "created_date": {
               "anyOf": [
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ISO8601 date this metadata record was created",
               "title": "Created Date"
            },
            "publication_date": {
               "anyOf": [
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The date which the version of record was published.",
               "title": "Publication Date"
            },
            "publication_year": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The year in which the version of record was published.",
               "title": "Publication Year"
            },
            "publisher": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the entity which published the version of record.",
               "title": "Publisher"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The title of the reference.",
               "title": "Title"
            }
         },
         "title": "BibliographicMetadataEnhancement",
         "type": "object"
      },
      "BooleanAnnotation": {
         "description": "An annotation is a way of tagging the content with a label of some kind.\n\nThis class will probably be broken up in the future, but covers most of our\ninitial cases.",
         "properties": {
            "annotation_type": {
               "const": "boolean",
               "default": "boolean",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of the annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "value": {
               "description": "Boolean flag for this annotation",
               "title": "Value",
               "type": "boolean"
            },
            "score": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A confidence score for this annotation",
               "title": "Score"
            },
            "data": {
               "additionalProperties": true,
               "description": "\nAn object representation of the annotation including any confidence scores or\ndescriptions.\n",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "value"
         ],
         "title": "BooleanAnnotation",
         "type": "object"
      },
      "DriverVersion": {
         "description": "The version based on the DRIVER guidelines versioning scheme.\n\n(Borrowed from OpenAlex)",
         "enum": [
            "publishedVersion",
            "acceptedVersion",
            "submittedVersion",
            "other"
         ],
         "title": "DriverVersion",
         "type": "string"
      },
      "Location": {
         "description": "A location where a reference can be found.\n\nThis maps almost completely to the OpenAlex\n[Location object](https://docs.openalex.org/api-entities/works/work-object/location-object)",
         "properties": {
            "is_oa": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): True if an Open Access (OA) version of this work is available\nat this location. May be left as null if this is unknown (and thus)\ntreated effectively as `false`.\n",
               "title": "Is Oa"
            },
            "version": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/DriverVersion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\nThe version (according to the DRIVER versioning scheme) of this location.\n"
            },
            "landing_page_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "(From OpenAlex): The landing page URL for this location.",
               "title": "Landing Page Url"
            },
            "pdf_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): A URL where you can find this location as a PDF.\n",
               "title": "Pdf Url"
            },
            "license": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): The location's publishing license. This can be a Creative\nCommons license such as cc0 or cc-by, a publisher-specific license, or null\nwhich means we are not able to determine a license for this location.\n",
               "title": "License"
            },
            "extra": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Any extra metadata about this location",
               "title": "Extra"
            }
         },
         "title": "Location",
         "type": "object"
      },
      "LocationEnhancement": {
         "description": "An enhancement which describes locations where this reference can be found.\n\nThis maps closely (almost exactly) to OpenAlex's locations.",
         "properties": {
            "enhancement_type": {
               "const": "location",
               "default": "location",
               "title": "Enhancement Type",
               "type": "string"
            },
            "locations": {
               "description": "A list of locations where this reference can be found.",
               "items": {
                  "$ref": "#/$defs/Location"
               },
               "minItems": 1,
               "title": "Locations",
               "type": "array"
            }
         },
         "required": [
            "locations"
         ],
         "title": "LocationEnhancement",
         "type": "object"
      },
      "ScoreAnnotation": {
         "description": "An annotation which represents the score for a label.\n\nThis is similar to a BooleanAnnotation, but lacks a boolean determination\nas to the application of the label.",
         "properties": {
            "annotation_type": {
               "const": "score",
               "default": "score",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "score": {
               "description": "Score for this annotation",
               "title": "Score",
               "type": "number"
            },
            "data": {
               "additionalProperties": true,
               "description": "An object representation of the annotation including any confidence scores or descriptions.",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "score"
         ],
         "title": "ScoreAnnotation",
         "type": "object"
      },
      "Visibility": {
         "description": "The visibility of a data element in the repository.\n\nThis is used to manage whether information should be publicly available or\nrestricted (generally due to copyright constraints from publishers).",
         "enum": [
            "public",
            "restricted",
            "hidden"
         ],
         "title": "Visibility",
         "type": "string"
      }
   },
   "required": [
      "reference_id",
      "source",
      "visibility",
      "content"
   ]
}

Fields:

• content (libs.sdk.src.destiny_sdk.enhancements.BibliographicMetadataEnhancement | libs.sdk.src.destiny_sdk.enhancements.AbstractContentEnhancement | libs.sdk.src.destiny_sdk.enhancements.AnnotationEnhancement | libs.sdk.src.destiny_sdk.enhancements.LocationEnhancement)

• derived_from (list[uuid.UUID] | None)

• id (uuid.UUID | None)

• reference_id (uuid.UUID)

• robot_version (str | None)

• source (str)

• visibility (destiny_sdk.visibility.Visibility)

field content: Annotated[BibliographicMetadataEnhancement | AbstractContentEnhancement | AnnotationEnhancement | LocationEnhancement, FieldInfo(annotation=NoneType, required=True, discriminator='enhancement_type'), FieldInfo(annotation=NoneType, required=True, description='The content of the enhancement.', discriminator='enhancement_type')] [Required]

The content of the enhancement.

field derived_from: list[Annotated[UUID, UuidVersion(uuid_version=4)]] | None = None

List of enhancement IDs that this enhancement was derived from.

field id: Annotated[UUID, UuidVersion(uuid_version=4)] | None = None

The ID of the enhancement. Populated by the repository when sending enhancements with references.

field reference_id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the reference this enhancement is associated with.

Constraints:

• uuid_version = 4

field robot_version: str | None = None

The version of the robot that generated the content.

field source: str [Required]

The enhancement source for tracking provenance.

field visibility: Visibility [Required]

The level of visibility of the enhancement

classmethod from_jsonl(jsonl: str) → Self

Create an object from a JSONL string.

Parameters:

jsonl (str) – The JSONL string to parse.

Returns:

The created object.

Return type:

Self

to_jsonl() → str

Convert the model to a JSONL string.

Returns:

The JSONL string representation of the model.

Return type:

str

libs.sdk.src.destiny_sdk.enhancements.EnhancementContent

Union type for all enhancement content types.

alias of Annotated[BibliographicMetadataEnhancement | AbstractContentEnhancement | AnnotationEnhancement | LocationEnhancement, FieldInfo(annotation=NoneType, required=True, discriminator=’enhancement_type’)]

pydantic model libs.sdk.src.destiny_sdk.enhancements.EnhancementFileInput

Enhancement model used to marshall a file input to new references.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "EnhancementFileInput",
   "description": "Enhancement model used to marshall a file input to new references.",
   "type": "object",
   "properties": {
      "source": {
         "description": "The enhancement source for tracking provenance.",
         "title": "Source",
         "type": "string"
      },
      "visibility": {
         "$ref": "#/$defs/Visibility",
         "description": "The level of visibility of the enhancement"
      },
      "processor_version": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The version of the robot that generated the content.",
         "title": "Processor Version"
      },
      "content": {
         "description": "The content of the enhancement.",
         "discriminator": {
            "mapping": {
               "abstract": "#/$defs/AbstractContentEnhancement",
               "annotation": "#/$defs/AnnotationEnhancement",
               "bibliographic": "#/$defs/BibliographicMetadataEnhancement",
               "location": "#/$defs/LocationEnhancement"
            },
            "propertyName": "enhancement_type"
         },
         "oneOf": [
            {
               "$ref": "#/$defs/BibliographicMetadataEnhancement"
            },
            {
               "$ref": "#/$defs/AbstractContentEnhancement"
            },
            {
               "$ref": "#/$defs/AnnotationEnhancement"
            },
            {
               "$ref": "#/$defs/LocationEnhancement"
            }
         ],
         "title": "Content"
      }
   },
   "$defs": {
      "AbstractContentEnhancement": {
         "description": "An enhancement which is specific to the abstract of a reference.\n\nThis is separate from the `BibliographicMetadata` for two reasons:\n\n1. Abstracts are increasingly missing from sources like OpenAlex, and may be\nbackfilled from other sources, without the bibliographic metadata.\n2. They are also subject to copyright limitations in ways which metadata are\nnot, and thus need separate visibility controls.",
         "properties": {
            "enhancement_type": {
               "const": "abstract",
               "default": "abstract",
               "title": "Enhancement Type",
               "type": "string"
            },
            "process": {
               "$ref": "#/$defs/AbstractProcessType"
            },
            "abstract": {
               "description": "The abstract of the reference.",
               "title": "Abstract",
               "type": "string"
            }
         },
         "required": [
            "process",
            "abstract"
         ],
         "title": "AbstractContentEnhancement",
         "type": "object"
      },
      "AbstractProcessType": {
         "description": "The process used to acquire the abstract.",
         "enum": [
            "uninverted",
            "closed_api",
            "other"
         ],
         "title": "AbstractProcessType",
         "type": "string"
      },
      "AnnotationEnhancement": {
         "description": "An enhancement which is composed of a list of Annotations.",
         "properties": {
            "enhancement_type": {
               "const": "annotation",
               "default": "annotation",
               "title": "Enhancement Type",
               "type": "string"
            },
            "annotations": {
               "items": {
                  "discriminator": {
                     "mapping": {
                        "boolean": "#/$defs/BooleanAnnotation",
                        "score": "#/$defs/ScoreAnnotation"
                     },
                     "propertyName": "annotation_type"
                  },
                  "oneOf": [
                     {
                        "$ref": "#/$defs/BooleanAnnotation"
                     },
                     {
                        "$ref": "#/$defs/ScoreAnnotation"
                     }
                  ]
               },
               "minItems": 1,
               "title": "Annotations",
               "type": "array"
            }
         },
         "required": [
            "annotations"
         ],
         "title": "AnnotationEnhancement",
         "type": "object"
      },
      "AuthorPosition": {
         "description": "The position of an author in a list of authorships.\n\nMaps to the data from OpenAlex.",
         "enum": [
            "first",
            "middle",
            "last"
         ],
         "title": "AuthorPosition",
         "type": "string"
      },
      "Authorship": {
         "description": "Represents a single author and their association with a reference.\n\nThis is a simplification of the OpenAlex [Authorship\nobject](https://docs.openalex.org/api-entities/works/work-object/authorship-object)\nfor our purposes.",
         "properties": {
            "display_name": {
               "description": "The display name of the author.",
               "title": "Display Name",
               "type": "string"
            },
            "orcid": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ORCid of the author.",
               "title": "Orcid"
            },
            "position": {
               "$ref": "#/$defs/AuthorPosition",
               "description": "The position of the author within the list of authors."
            }
         },
         "required": [
            "display_name",
            "position"
         ],
         "title": "Authorship",
         "type": "object"
      },
      "BibliographicMetadataEnhancement": {
         "description": "An enhancement which is made up of bibliographic metadata.\n\nGenerally this will be sourced from a database such as OpenAlex or similar.\nFor directly contributed references, these may not be complete.",
         "properties": {
            "enhancement_type": {
               "const": "bibliographic",
               "default": "bibliographic",
               "title": "Enhancement Type",
               "type": "string"
            },
            "authorship": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Authorship"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of `Authorships` belonging to this reference.",
               "title": "Authorship"
            },
            "cited_by_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex) The number of citations to this work. These are the times that\nother works have cited this work\n",
               "title": "Cited By Count"
            },
            "created_date": {
               "anyOf": [
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ISO8601 date this metadata record was created",
               "title": "Created Date"
            },
            "publication_date": {
               "anyOf": [
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The date which the version of record was published.",
               "title": "Publication Date"
            },
            "publication_year": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The year in which the version of record was published.",
               "title": "Publication Year"
            },
            "publisher": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the entity which published the version of record.",
               "title": "Publisher"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The title of the reference.",
               "title": "Title"
            }
         },
         "title": "BibliographicMetadataEnhancement",
         "type": "object"
      },
      "BooleanAnnotation": {
         "description": "An annotation is a way of tagging the content with a label of some kind.\n\nThis class will probably be broken up in the future, but covers most of our\ninitial cases.",
         "properties": {
            "annotation_type": {
               "const": "boolean",
               "default": "boolean",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of the annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "value": {
               "description": "Boolean flag for this annotation",
               "title": "Value",
               "type": "boolean"
            },
            "score": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A confidence score for this annotation",
               "title": "Score"
            },
            "data": {
               "additionalProperties": true,
               "description": "\nAn object representation of the annotation including any confidence scores or\ndescriptions.\n",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "value"
         ],
         "title": "BooleanAnnotation",
         "type": "object"
      },
      "DriverVersion": {
         "description": "The version based on the DRIVER guidelines versioning scheme.\n\n(Borrowed from OpenAlex)",
         "enum": [
            "publishedVersion",
            "acceptedVersion",
            "submittedVersion",
            "other"
         ],
         "title": "DriverVersion",
         "type": "string"
      },
      "Location": {
         "description": "A location where a reference can be found.\n\nThis maps almost completely to the OpenAlex\n[Location object](https://docs.openalex.org/api-entities/works/work-object/location-object)",
         "properties": {
            "is_oa": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): True if an Open Access (OA) version of this work is available\nat this location. May be left as null if this is unknown (and thus)\ntreated effectively as `false`.\n",
               "title": "Is Oa"
            },
            "version": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/DriverVersion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\nThe version (according to the DRIVER versioning scheme) of this location.\n"
            },
            "landing_page_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "(From OpenAlex): The landing page URL for this location.",
               "title": "Landing Page Url"
            },
            "pdf_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): A URL where you can find this location as a PDF.\n",
               "title": "Pdf Url"
            },
            "license": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): The location's publishing license. This can be a Creative\nCommons license such as cc0 or cc-by, a publisher-specific license, or null\nwhich means we are not able to determine a license for this location.\n",
               "title": "License"
            },
            "extra": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Any extra metadata about this location",
               "title": "Extra"
            }
         },
         "title": "Location",
         "type": "object"
      },
      "LocationEnhancement": {
         "description": "An enhancement which describes locations where this reference can be found.\n\nThis maps closely (almost exactly) to OpenAlex's locations.",
         "properties": {
            "enhancement_type": {
               "const": "location",
               "default": "location",
               "title": "Enhancement Type",
               "type": "string"
            },
            "locations": {
               "description": "A list of locations where this reference can be found.",
               "items": {
                  "$ref": "#/$defs/Location"
               },
               "minItems": 1,
               "title": "Locations",
               "type": "array"
            }
         },
         "required": [
            "locations"
         ],
         "title": "LocationEnhancement",
         "type": "object"
      },
      "ScoreAnnotation": {
         "description": "An annotation which represents the score for a label.\n\nThis is similar to a BooleanAnnotation, but lacks a boolean determination\nas to the application of the label.",
         "properties": {
            "annotation_type": {
               "const": "score",
               "default": "score",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "score": {
               "description": "Score for this annotation",
               "title": "Score",
               "type": "number"
            },
            "data": {
               "additionalProperties": true,
               "description": "An object representation of the annotation including any confidence scores or descriptions.",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "score"
         ],
         "title": "ScoreAnnotation",
         "type": "object"
      },
      "Visibility": {
         "description": "The visibility of a data element in the repository.\n\nThis is used to manage whether information should be publicly available or\nrestricted (generally due to copyright constraints from publishers).",
         "enum": [
            "public",
            "restricted",
            "hidden"
         ],
         "title": "Visibility",
         "type": "string"
      }
   },
   "required": [
      "source",
      "visibility",
      "content"
   ]
}

Fields:

• content (libs.sdk.src.destiny_sdk.enhancements.BibliographicMetadataEnhancement | libs.sdk.src.destiny_sdk.enhancements.AbstractContentEnhancement | libs.sdk.src.destiny_sdk.enhancements.AnnotationEnhancement | libs.sdk.src.destiny_sdk.enhancements.LocationEnhancement)

• robot_version (str | None)

• source (str)

• visibility (destiny_sdk.visibility.Visibility)

field content: Annotated[BibliographicMetadataEnhancement | AbstractContentEnhancement | AnnotationEnhancement | LocationEnhancement, FieldInfo(annotation=NoneType, required=True, discriminator='enhancement_type')] [Required]

The content of the enhancement.

field robot_version: str | None = None (alias 'processor_version')

The version of the robot that generated the content.

field source: str [Required]

The enhancement source for tracking provenance.

field visibility: Visibility [Required]

The level of visibility of the enhancement

class libs.sdk.src.destiny_sdk.enhancements.EnhancementType(*values)

The type of enhancement.

This is used to identify the type of enhancement in the Enhancement class.

ABSTRACT = 'abstract'

The abstract of a reference.

ANNOTATION = 'annotation'

A free-form enhancement for tagging with labels.

BIBLIOGRAPHIC = 'bibliographic'

Bibliographic metadata.

FULL_TEXT = 'full_text'

The full text of the reference. (To be implemented)

LOCATION = 'location'

Locations where the reference can be found.

pydantic model libs.sdk.src.destiny_sdk.enhancements.Location

A location where a reference can be found.

This maps almost completely to the OpenAlex [Location object](https://docs.openalex.org/api-entities/works/work-object/location-object)

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "Location",
   "description": "A location where a reference can be found.\n\nThis maps almost completely to the OpenAlex\n[Location object](https://docs.openalex.org/api-entities/works/work-object/location-object)",
   "type": "object",
   "properties": {
      "is_oa": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\n(From OpenAlex): True if an Open Access (OA) version of this work is available\nat this location. May be left as null if this is unknown (and thus)\ntreated effectively as `false`.\n",
         "title": "Is Oa"
      },
      "version": {
         "anyOf": [
            {
               "$ref": "#/$defs/DriverVersion"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\nThe version (according to the DRIVER versioning scheme) of this location.\n"
      },
      "landing_page_url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "(From OpenAlex): The landing page URL for this location.",
         "title": "Landing Page Url"
      },
      "pdf_url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\n(From OpenAlex): A URL where you can find this location as a PDF.\n",
         "title": "Pdf Url"
      },
      "license": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "\n(From OpenAlex): The location's publishing license. This can be a Creative\nCommons license such as cc0 or cc-by, a publisher-specific license, or null\nwhich means we are not able to determine a license for this location.\n",
         "title": "License"
      },
      "extra": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Any extra metadata about this location",
         "title": "Extra"
      }
   },
   "$defs": {
      "DriverVersion": {
         "description": "The version based on the DRIVER guidelines versioning scheme.\n\n(Borrowed from OpenAlex)",
         "enum": [
            "publishedVersion",
            "acceptedVersion",
            "submittedVersion",
            "other"
         ],
         "title": "DriverVersion",
         "type": "string"
      }
   }
}

Fields:

• extra (dict | None)

• is_oa (bool | None)

• landing_page_url (pydantic.networks.HttpUrl | None)

• license (str | None)

• pdf_url (pydantic.networks.HttpUrl | None)

• version (libs.sdk.src.destiny_sdk.enhancements.DriverVersion | None)

field extra: dict | None = None

Any extra metadata about this location

field is_oa: bool | None = None

(From OpenAlex): True if an Open Access (OA) version of this work is available at this location. May be left as null if this is unknown (and thus) treated effectively as false.

field landing_page_url: HttpUrl | None = None

(From OpenAlex): The landing page URL for this location.

field license: str | None = None

(From OpenAlex): The location’s publishing license. This can be a Creative Commons license such as cc0 or cc-by, a publisher-specific license, or null which means we are not able to determine a license for this location.

field pdf_url: HttpUrl | None = None

(From OpenAlex): A URL where you can find this location as a PDF.

field version: DriverVersion | None = None

The version (according to the DRIVER versioning scheme) of this location.

pydantic model libs.sdk.src.destiny_sdk.enhancements.LocationEnhancement

An enhancement which describes locations where this reference can be found.

This maps closely (almost exactly) to OpenAlex’s locations.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "LocationEnhancement",
   "description": "An enhancement which describes locations where this reference can be found.\n\nThis maps closely (almost exactly) to OpenAlex's locations.",
   "type": "object",
   "properties": {
      "enhancement_type": {
         "const": "location",
         "default": "location",
         "title": "Enhancement Type",
         "type": "string"
      },
      "locations": {
         "description": "A list of locations where this reference can be found.",
         "items": {
            "$ref": "#/$defs/Location"
         },
         "minItems": 1,
         "title": "Locations",
         "type": "array"
      }
   },
   "$defs": {
      "DriverVersion": {
         "description": "The version based on the DRIVER guidelines versioning scheme.\n\n(Borrowed from OpenAlex)",
         "enum": [
            "publishedVersion",
            "acceptedVersion",
            "submittedVersion",
            "other"
         ],
         "title": "DriverVersion",
         "type": "string"
      },
      "Location": {
         "description": "A location where a reference can be found.\n\nThis maps almost completely to the OpenAlex\n[Location object](https://docs.openalex.org/api-entities/works/work-object/location-object)",
         "properties": {
            "is_oa": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): True if an Open Access (OA) version of this work is available\nat this location. May be left as null if this is unknown (and thus)\ntreated effectively as `false`.\n",
               "title": "Is Oa"
            },
            "version": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/DriverVersion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\nThe version (according to the DRIVER versioning scheme) of this location.\n"
            },
            "landing_page_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "(From OpenAlex): The landing page URL for this location.",
               "title": "Landing Page Url"
            },
            "pdf_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): A URL where you can find this location as a PDF.\n",
               "title": "Pdf Url"
            },
            "license": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): The location's publishing license. This can be a Creative\nCommons license such as cc0 or cc-by, a publisher-specific license, or null\nwhich means we are not able to determine a license for this location.\n",
               "title": "License"
            },
            "extra": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Any extra metadata about this location",
               "title": "Extra"
            }
         },
         "title": "Location",
         "type": "object"
      }
   },
   "required": [
      "locations"
   ]
}

Fields:

• enhancement_type (Literal[libs.sdk.src.destiny_sdk.enhancements.EnhancementType.LOCATION])

• locations (list[libs.sdk.src.destiny_sdk.enhancements.Location])

field enhancement_type: Literal[EnhancementType.LOCATION] = EnhancementType.LOCATION

field locations: list[Location] [Required]

A list of locations where this reference can be found.

Constraints:

• min_length = 1

pydantic model libs.sdk.src.destiny_sdk.enhancements.ScoreAnnotation

An annotation which represents the score for a label.

This is similar to a BooleanAnnotation, but lacks a boolean determination as to the application of the label.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "ScoreAnnotation",
   "description": "An annotation which represents the score for a label.\n\nThis is similar to a BooleanAnnotation, but lacks a boolean determination\nas to the application of the label.",
   "type": "object",
   "properties": {
      "annotation_type": {
         "const": "score",
         "default": "score",
         "title": "Annotation Type",
         "type": "string"
      },
      "scheme": {
         "description": "An identifier for the scheme of annotation",
         "examples": [
            "openalex:topic",
            "pubmed:mesh"
         ],
         "title": "Scheme",
         "type": "string"
      },
      "label": {
         "description": "A high level label for this annotation like the name of the topic",
         "title": "Label",
         "type": "string"
      },
      "score": {
         "description": "Score for this annotation",
         "title": "Score",
         "type": "number"
      },
      "data": {
         "additionalProperties": true,
         "description": "An object representation of the annotation including any confidence scores or descriptions.",
         "title": "Data",
         "type": "object"
      }
   },
   "required": [
      "scheme",
      "label",
      "score"
   ]
}

Fields:

• annotation_type (Literal[libs.sdk.src.destiny_sdk.enhancements.AnnotationType.SCORE])

• data (dict)

• label (str)

• scheme (str)

• score (float)

field annotation_type: Literal[AnnotationType.SCORE] = AnnotationType.SCORE

field data: dict [Optional]

An object representation of the annotation including any confidence scores or descriptions.

field label: str [Required]

A high level label for this annotation like the name of the topic

field scheme: str [Required]

An identifier for the scheme of annotation

field score: float [Required]

Score for this annotation

Identifiers

Identifier classes for the Destiny SDK.

pydantic model libs.sdk.src.destiny_sdk.identifiers.DOIIdentifier

An external identifier representing a DOI.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "DOIIdentifier",
   "description": "An external identifier representing a DOI.",
   "type": "object",
   "properties": {
      "identifier": {
         "description": "The DOI of the reference.",
         "pattern": "^10\\.\\d{4,9}/[-._;()/:a-zA-Z0-9%<>\\[\\]+&]+$",
         "title": "Identifier",
         "type": "string"
      },
      "identifier_type": {
         "const": "doi",
         "default": "doi",
         "description": "The type of identifier used.",
         "title": "Identifier Type",
         "type": "string"
      }
   },
   "required": [
      "identifier"
   ]
}

Fields:

• identifier (str)

• identifier_type (Literal[libs.sdk.src.destiny_sdk.identifiers.ExternalIdentifierType.DOI])

Validators:

• remove_doi_url » identifier

field identifier: str [Required]

The DOI of the reference.

Constraints:

• pattern = ^10.d{4,9}/[-._;()/:a-zA-Z0-9%<>[]+&]+$

Validated by:

• remove_doi_url

field identifier_type: Literal[ExternalIdentifierType.DOI] = ExternalIdentifierType.DOI

The type of identifier used.

validator remove_doi_url  »  identifier

Remove the URL part of the DOI if it exists.

libs.sdk.src.destiny_sdk.identifiers.ExternalIdentifier

Union type for all external identifiers.

alias of Annotated[DOIIdentifier | PubMedIdentifier | OpenAlexIdentifier | OtherIdentifier, FieldInfo(annotation=NoneType, required=True, discriminator=’identifier_type’)]

class libs.sdk.src.destiny_sdk.identifiers.ExternalIdentifierType(*values)

The type of identifier used to identify a reference.

This is used to identify the type of identifier used in the ExternalIdentifier class.

DOI = 'doi'

A DOI (Digital Object Identifier) which is a unique identifier for a document.

OPEN_ALEX = 'open_alex'

An OpenAlex ID which is a unique identifier for a document in OpenAlex.

OTHER = 'other'

Any other identifier not defined. This should be used sparingly.

PM_ID = 'pm_id'

A PubMed ID which is a unique identifier for a document in PubMed.

pydantic model libs.sdk.src.destiny_sdk.identifiers.LinkedExternalIdentifier

An external identifier which identifies a reference.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "LinkedExternalIdentifier",
   "description": "An external identifier which identifies a reference.",
   "type": "object",
   "properties": {
      "identifier": {
         "description": "The identifier of the reference.",
         "discriminator": {
            "mapping": {
               "doi": "#/$defs/DOIIdentifier",
               "open_alex": "#/$defs/OpenAlexIdentifier",
               "other": "#/$defs/OtherIdentifier",
               "pm_id": "#/$defs/PubMedIdentifier"
            },
            "propertyName": "identifier_type"
         },
         "oneOf": [
            {
               "$ref": "#/$defs/DOIIdentifier"
            },
            {
               "$ref": "#/$defs/PubMedIdentifier"
            },
            {
               "$ref": "#/$defs/OpenAlexIdentifier"
            },
            {
               "$ref": "#/$defs/OtherIdentifier"
            }
         ],
         "title": "Identifier"
      },
      "reference_id": {
         "description": "The ID of the reference this identifier identifies.",
         "format": "uuid4",
         "title": "Reference Id",
         "type": "string"
      }
   },
   "$defs": {
      "DOIIdentifier": {
         "description": "An external identifier representing a DOI.",
         "properties": {
            "identifier": {
               "description": "The DOI of the reference.",
               "pattern": "^10\\.\\d{4,9}/[-._;()/:a-zA-Z0-9%<>\\[\\]+&]+$",
               "title": "Identifier",
               "type": "string"
            },
            "identifier_type": {
               "const": "doi",
               "default": "doi",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            }
         },
         "required": [
            "identifier"
         ],
         "title": "DOIIdentifier",
         "type": "object"
      },
      "OpenAlexIdentifier": {
         "description": "An external identifier representing an OpenAlex ID.",
         "properties": {
            "identifier": {
               "description": "The OpenAlex ID of the reference.",
               "pattern": "^W\\d+$",
               "title": "Identifier",
               "type": "string"
            },
            "identifier_type": {
               "const": "open_alex",
               "default": "open_alex",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            }
         },
         "required": [
            "identifier"
         ],
         "title": "OpenAlexIdentifier",
         "type": "object"
      },
      "OtherIdentifier": {
         "description": "An external identifier not otherwise defined by the repository.",
         "properties": {
            "identifier": {
               "description": "The identifier of the reference.",
               "title": "Identifier",
               "type": "string"
            },
            "identifier_type": {
               "const": "other",
               "default": "other",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            },
            "other_identifier_name": {
               "description": "The name of the undocumented identifier type.",
               "title": "Other Identifier Name",
               "type": "string"
            }
         },
         "required": [
            "identifier",
            "other_identifier_name"
         ],
         "title": "OtherIdentifier",
         "type": "object"
      },
      "PubMedIdentifier": {
         "description": "An external identifier representing a PubMed ID.",
         "properties": {
            "identifier": {
               "description": "The PubMed ID of the reference.",
               "title": "Identifier",
               "type": "integer"
            },
            "identifier_type": {
               "const": "pm_id",
               "default": "pm_id",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            }
         },
         "required": [
            "identifier"
         ],
         "title": "PubMedIdentifier",
         "type": "object"
      }
   },
   "required": [
      "identifier",
      "reference_id"
   ]
}

Fields:

• identifier (libs.sdk.src.destiny_sdk.identifiers.DOIIdentifier | libs.sdk.src.destiny_sdk.identifiers.PubMedIdentifier | libs.sdk.src.destiny_sdk.identifiers.OpenAlexIdentifier | libs.sdk.src.destiny_sdk.identifiers.OtherIdentifier)

• reference_id (uuid.UUID)

field identifier: Annotated[DOIIdentifier | PubMedIdentifier | OpenAlexIdentifier | OtherIdentifier, FieldInfo(annotation=NoneType, required=True, discriminator='identifier_type')] [Required]

The identifier of the reference.

field reference_id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the reference this identifier identifies.

Constraints:

• uuid_version = 4

pydantic model libs.sdk.src.destiny_sdk.identifiers.OpenAlexIdentifier

An external identifier representing an OpenAlex ID.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "OpenAlexIdentifier",
   "description": "An external identifier representing an OpenAlex ID.",
   "type": "object",
   "properties": {
      "identifier": {
         "description": "The OpenAlex ID of the reference.",
         "pattern": "^W\\d+$",
         "title": "Identifier",
         "type": "string"
      },
      "identifier_type": {
         "const": "open_alex",
         "default": "open_alex",
         "description": "The type of identifier used.",
         "title": "Identifier Type",
         "type": "string"
      }
   },
   "required": [
      "identifier"
   ]
}

Fields:

• identifier (str)

• identifier_type (Literal[libs.sdk.src.destiny_sdk.identifiers.ExternalIdentifierType.OPEN_ALEX])

Validators:

• remove_open_alex_url » identifier

field identifier: str [Required]

The OpenAlex ID of the reference.

Constraints:

• pattern = ^Wd+$

Validated by:

• remove_open_alex_url

field identifier_type: Literal[ExternalIdentifierType.OPEN_ALEX] = ExternalIdentifierType.OPEN_ALEX

The type of identifier used.

validator remove_open_alex_url  »  identifier

Remove the OpenAlex URL if it exists.

pydantic model libs.sdk.src.destiny_sdk.identifiers.OtherIdentifier

An external identifier not otherwise defined by the repository.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "OtherIdentifier",
   "description": "An external identifier not otherwise defined by the repository.",
   "type": "object",
   "properties": {
      "identifier": {
         "description": "The identifier of the reference.",
         "title": "Identifier",
         "type": "string"
      },
      "identifier_type": {
         "const": "other",
         "default": "other",
         "description": "The type of identifier used.",
         "title": "Identifier Type",
         "type": "string"
      },
      "other_identifier_name": {
         "description": "The name of the undocumented identifier type.",
         "title": "Other Identifier Name",
         "type": "string"
      }
   },
   "required": [
      "identifier",
      "other_identifier_name"
   ]
}

Fields:

• identifier (str)

• identifier_type (Literal[libs.sdk.src.destiny_sdk.identifiers.ExternalIdentifierType.OTHER])

• other_identifier_name (str)

field identifier: str [Required]

The identifier of the reference.

field identifier_type: Literal[ExternalIdentifierType.OTHER] = ExternalIdentifierType.OTHER

The type of identifier used.

field other_identifier_name: str [Required]

The name of the undocumented identifier type.

pydantic model libs.sdk.src.destiny_sdk.identifiers.PubMedIdentifier

An external identifier representing a PubMed ID.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "PubMedIdentifier",
   "description": "An external identifier representing a PubMed ID.",
   "type": "object",
   "properties": {
      "identifier": {
         "description": "The PubMed ID of the reference.",
         "title": "Identifier",
         "type": "integer"
      },
      "identifier_type": {
         "const": "pm_id",
         "default": "pm_id",
         "description": "The type of identifier used.",
         "title": "Identifier Type",
         "type": "string"
      }
   },
   "required": [
      "identifier"
   ]
}

Fields:

• identifier (int)

• identifier_type (Literal[libs.sdk.src.destiny_sdk.identifiers.ExternalIdentifierType.PM_ID])

field identifier: int [Required]

The PubMed ID of the reference.

field identifier_type: Literal[ExternalIdentifierType.PM_ID] = ExternalIdentifierType.PM_ID

The type of identifier used.

References

Reference classes for the Destiny SDK.

pydantic model libs.sdk.src.destiny_sdk.references.Reference

Core reference class.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "Reference",
   "description": "Core reference class.",
   "type": "object",
   "properties": {
      "visibility": {
         "$ref": "#/$defs/Visibility",
         "default": "public",
         "description": "The level of visibility of the reference"
      },
      "id": {
         "description": "The ID of the reference",
         "format": "uuid4",
         "title": "Id",
         "type": "string"
      },
      "identifiers": {
         "anyOf": [
            {
               "items": {
                  "discriminator": {
                     "mapping": {
                        "doi": "#/$defs/DOIIdentifier",
                        "open_alex": "#/$defs/OpenAlexIdentifier",
                        "other": "#/$defs/OtherIdentifier",
                        "pm_id": "#/$defs/PubMedIdentifier"
                     },
                     "propertyName": "identifier_type"
                  },
                  "oneOf": [
                     {
                        "$ref": "#/$defs/DOIIdentifier"
                     },
                     {
                        "$ref": "#/$defs/PubMedIdentifier"
                     },
                     {
                        "$ref": "#/$defs/OpenAlexIdentifier"
                     },
                     {
                        "$ref": "#/$defs/OtherIdentifier"
                     }
                  ]
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A list of `ExternalIdentifiers` for the Reference",
         "title": "Identifiers"
      },
      "enhancements": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Enhancement"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A list of enhancements for the reference",
         "title": "Enhancements"
      }
   },
   "$defs": {
      "AbstractContentEnhancement": {
         "description": "An enhancement which is specific to the abstract of a reference.\n\nThis is separate from the `BibliographicMetadata` for two reasons:\n\n1. Abstracts are increasingly missing from sources like OpenAlex, and may be\nbackfilled from other sources, without the bibliographic metadata.\n2. They are also subject to copyright limitations in ways which metadata are\nnot, and thus need separate visibility controls.",
         "properties": {
            "enhancement_type": {
               "const": "abstract",
               "default": "abstract",
               "title": "Enhancement Type",
               "type": "string"
            },
            "process": {
               "$ref": "#/$defs/AbstractProcessType"
            },
            "abstract": {
               "description": "The abstract of the reference.",
               "title": "Abstract",
               "type": "string"
            }
         },
         "required": [
            "process",
            "abstract"
         ],
         "title": "AbstractContentEnhancement",
         "type": "object"
      },
      "AbstractProcessType": {
         "description": "The process used to acquire the abstract.",
         "enum": [
            "uninverted",
            "closed_api",
            "other"
         ],
         "title": "AbstractProcessType",
         "type": "string"
      },
      "AnnotationEnhancement": {
         "description": "An enhancement which is composed of a list of Annotations.",
         "properties": {
            "enhancement_type": {
               "const": "annotation",
               "default": "annotation",
               "title": "Enhancement Type",
               "type": "string"
            },
            "annotations": {
               "items": {
                  "discriminator": {
                     "mapping": {
                        "boolean": "#/$defs/BooleanAnnotation",
                        "score": "#/$defs/ScoreAnnotation"
                     },
                     "propertyName": "annotation_type"
                  },
                  "oneOf": [
                     {
                        "$ref": "#/$defs/BooleanAnnotation"
                     },
                     {
                        "$ref": "#/$defs/ScoreAnnotation"
                     }
                  ]
               },
               "minItems": 1,
               "title": "Annotations",
               "type": "array"
            }
         },
         "required": [
            "annotations"
         ],
         "title": "AnnotationEnhancement",
         "type": "object"
      },
      "AuthorPosition": {
         "description": "The position of an author in a list of authorships.\n\nMaps to the data from OpenAlex.",
         "enum": [
            "first",
            "middle",
            "last"
         ],
         "title": "AuthorPosition",
         "type": "string"
      },
      "Authorship": {
         "description": "Represents a single author and their association with a reference.\n\nThis is a simplification of the OpenAlex [Authorship\nobject](https://docs.openalex.org/api-entities/works/work-object/authorship-object)\nfor our purposes.",
         "properties": {
            "display_name": {
               "description": "The display name of the author.",
               "title": "Display Name",
               "type": "string"
            },
            "orcid": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ORCid of the author.",
               "title": "Orcid"
            },
            "position": {
               "$ref": "#/$defs/AuthorPosition",
               "description": "The position of the author within the list of authors."
            }
         },
         "required": [
            "display_name",
            "position"
         ],
         "title": "Authorship",
         "type": "object"
      },
      "BibliographicMetadataEnhancement": {
         "description": "An enhancement which is made up of bibliographic metadata.\n\nGenerally this will be sourced from a database such as OpenAlex or similar.\nFor directly contributed references, these may not be complete.",
         "properties": {
            "enhancement_type": {
               "const": "bibliographic",
               "default": "bibliographic",
               "title": "Enhancement Type",
               "type": "string"
            },
            "authorship": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Authorship"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of `Authorships` belonging to this reference.",
               "title": "Authorship"
            },
            "cited_by_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex) The number of citations to this work. These are the times that\nother works have cited this work\n",
               "title": "Cited By Count"
            },
            "created_date": {
               "anyOf": [
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ISO8601 date this metadata record was created",
               "title": "Created Date"
            },
            "publication_date": {
               "anyOf": [
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The date which the version of record was published.",
               "title": "Publication Date"
            },
            "publication_year": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The year in which the version of record was published.",
               "title": "Publication Year"
            },
            "publisher": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the entity which published the version of record.",
               "title": "Publisher"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The title of the reference.",
               "title": "Title"
            }
         },
         "title": "BibliographicMetadataEnhancement",
         "type": "object"
      },
      "BooleanAnnotation": {
         "description": "An annotation is a way of tagging the content with a label of some kind.\n\nThis class will probably be broken up in the future, but covers most of our\ninitial cases.",
         "properties": {
            "annotation_type": {
               "const": "boolean",
               "default": "boolean",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of the annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "value": {
               "description": "Boolean flag for this annotation",
               "title": "Value",
               "type": "boolean"
            },
            "score": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A confidence score for this annotation",
               "title": "Score"
            },
            "data": {
               "additionalProperties": true,
               "description": "\nAn object representation of the annotation including any confidence scores or\ndescriptions.\n",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "value"
         ],
         "title": "BooleanAnnotation",
         "type": "object"
      },
      "DOIIdentifier": {
         "description": "An external identifier representing a DOI.",
         "properties": {
            "identifier": {
               "description": "The DOI of the reference.",
               "pattern": "^10\\.\\d{4,9}/[-._;()/:a-zA-Z0-9%<>\\[\\]+&]+$",
               "title": "Identifier",
               "type": "string"
            },
            "identifier_type": {
               "const": "doi",
               "default": "doi",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            }
         },
         "required": [
            "identifier"
         ],
         "title": "DOIIdentifier",
         "type": "object"
      },
      "DriverVersion": {
         "description": "The version based on the DRIVER guidelines versioning scheme.\n\n(Borrowed from OpenAlex)",
         "enum": [
            "publishedVersion",
            "acceptedVersion",
            "submittedVersion",
            "other"
         ],
         "title": "DriverVersion",
         "type": "string"
      },
      "Enhancement": {
         "description": "Core enhancement class.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "format": "uuid4",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the enhancement. Populated by the repository when sending enhancements with references.",
               "title": "Id"
            },
            "reference_id": {
               "description": "The ID of the reference this enhancement is associated with.",
               "format": "uuid4",
               "title": "Reference Id",
               "type": "string"
            },
            "source": {
               "description": "The enhancement source for tracking provenance.",
               "title": "Source",
               "type": "string"
            },
            "visibility": {
               "$ref": "#/$defs/Visibility",
               "description": "The level of visibility of the enhancement"
            },
            "robot_version": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The version of the robot that generated the content.",
               "title": "Robot Version"
            },
            "derived_from": {
               "anyOf": [
                  {
                     "items": {
                        "format": "uuid4",
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of enhancement IDs that this enhancement was derived from.",
               "title": "Derived From"
            },
            "content": {
               "description": "The content of the enhancement.",
               "discriminator": {
                  "mapping": {
                     "abstract": "#/$defs/AbstractContentEnhancement",
                     "annotation": "#/$defs/AnnotationEnhancement",
                     "bibliographic": "#/$defs/BibliographicMetadataEnhancement",
                     "location": "#/$defs/LocationEnhancement"
                  },
                  "propertyName": "enhancement_type"
               },
               "oneOf": [
                  {
                     "$ref": "#/$defs/BibliographicMetadataEnhancement"
                  },
                  {
                     "$ref": "#/$defs/AbstractContentEnhancement"
                  },
                  {
                     "$ref": "#/$defs/AnnotationEnhancement"
                  },
                  {
                     "$ref": "#/$defs/LocationEnhancement"
                  }
               ],
               "title": "Content"
            }
         },
         "required": [
            "reference_id",
            "source",
            "visibility",
            "content"
         ],
         "title": "Enhancement",
         "type": "object"
      },
      "Location": {
         "description": "A location where a reference can be found.\n\nThis maps almost completely to the OpenAlex\n[Location object](https://docs.openalex.org/api-entities/works/work-object/location-object)",
         "properties": {
            "is_oa": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): True if an Open Access (OA) version of this work is available\nat this location. May be left as null if this is unknown (and thus)\ntreated effectively as `false`.\n",
               "title": "Is Oa"
            },
            "version": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/DriverVersion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\nThe version (according to the DRIVER versioning scheme) of this location.\n"
            },
            "landing_page_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "(From OpenAlex): The landing page URL for this location.",
               "title": "Landing Page Url"
            },
            "pdf_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): A URL where you can find this location as a PDF.\n",
               "title": "Pdf Url"
            },
            "license": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): The location's publishing license. This can be a Creative\nCommons license such as cc0 or cc-by, a publisher-specific license, or null\nwhich means we are not able to determine a license for this location.\n",
               "title": "License"
            },
            "extra": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Any extra metadata about this location",
               "title": "Extra"
            }
         },
         "title": "Location",
         "type": "object"
      },
      "LocationEnhancement": {
         "description": "An enhancement which describes locations where this reference can be found.\n\nThis maps closely (almost exactly) to OpenAlex's locations.",
         "properties": {
            "enhancement_type": {
               "const": "location",
               "default": "location",
               "title": "Enhancement Type",
               "type": "string"
            },
            "locations": {
               "description": "A list of locations where this reference can be found.",
               "items": {
                  "$ref": "#/$defs/Location"
               },
               "minItems": 1,
               "title": "Locations",
               "type": "array"
            }
         },
         "required": [
            "locations"
         ],
         "title": "LocationEnhancement",
         "type": "object"
      },
      "OpenAlexIdentifier": {
         "description": "An external identifier representing an OpenAlex ID.",
         "properties": {
            "identifier": {
               "description": "The OpenAlex ID of the reference.",
               "pattern": "^W\\d+$",
               "title": "Identifier",
               "type": "string"
            },
            "identifier_type": {
               "const": "open_alex",
               "default": "open_alex",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            }
         },
         "required": [
            "identifier"
         ],
         "title": "OpenAlexIdentifier",
         "type": "object"
      },
      "OtherIdentifier": {
         "description": "An external identifier not otherwise defined by the repository.",
         "properties": {
            "identifier": {
               "description": "The identifier of the reference.",
               "title": "Identifier",
               "type": "string"
            },
            "identifier_type": {
               "const": "other",
               "default": "other",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            },
            "other_identifier_name": {
               "description": "The name of the undocumented identifier type.",
               "title": "Other Identifier Name",
               "type": "string"
            }
         },
         "required": [
            "identifier",
            "other_identifier_name"
         ],
         "title": "OtherIdentifier",
         "type": "object"
      },
      "PubMedIdentifier": {
         "description": "An external identifier representing a PubMed ID.",
         "properties": {
            "identifier": {
               "description": "The PubMed ID of the reference.",
               "title": "Identifier",
               "type": "integer"
            },
            "identifier_type": {
               "const": "pm_id",
               "default": "pm_id",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            }
         },
         "required": [
            "identifier"
         ],
         "title": "PubMedIdentifier",
         "type": "object"
      },
      "ScoreAnnotation": {
         "description": "An annotation which represents the score for a label.\n\nThis is similar to a BooleanAnnotation, but lacks a boolean determination\nas to the application of the label.",
         "properties": {
            "annotation_type": {
               "const": "score",
               "default": "score",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "score": {
               "description": "Score for this annotation",
               "title": "Score",
               "type": "number"
            },
            "data": {
               "additionalProperties": true,
               "description": "An object representation of the annotation including any confidence scores or descriptions.",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "score"
         ],
         "title": "ScoreAnnotation",
         "type": "object"
      },
      "Visibility": {
         "description": "The visibility of a data element in the repository.\n\nThis is used to manage whether information should be publicly available or\nrestricted (generally due to copyright constraints from publishers).",
         "enum": [
            "public",
            "restricted",
            "hidden"
         ],
         "title": "Visibility",
         "type": "string"
      }
   },
   "required": [
      "id"
   ]
}

Fields:

• enhancements (list[destiny_sdk.enhancements.Enhancement] | None)

• id (uuid.UUID)

• identifiers (list[destiny_sdk.identifiers.DOIIdentifier | destiny_sdk.identifiers.PubMedIdentifier | destiny_sdk.identifiers.OpenAlexIdentifier | destiny_sdk.identifiers.OtherIdentifier] | None)

• visibility (destiny_sdk.visibility.Visibility)

field enhancements: list[Enhancement] | None = None

A list of enhancements for the reference

field id: Annotated[UUID, UuidVersion(uuid_version=4)] [Required]

The ID of the reference

Constraints:

• uuid_version = 4

field identifiers: list[Annotated[DOIIdentifier | PubMedIdentifier | OpenAlexIdentifier | OtherIdentifier, FieldInfo(annotation=NoneType, required=True, discriminator='identifier_type')]] | None = None

A list of ExternalIdentifiers for the Reference

field visibility: Visibility = Visibility.PUBLIC

The level of visibility of the reference

classmethod from_es(es_reference: dict) → Self

Create a Reference from an Elasticsearch document.

classmethod from_jsonl(jsonl: str) → Self

Create an object from a JSONL string.

Parameters:

jsonl (str) – The JSONL string to parse.

Returns:

The created object.

Return type:

Self

to_jsonl() → str

Convert the model to a JSONL string.

Returns:

The JSONL string representation of the model.

Return type:

str

pydantic model libs.sdk.src.destiny_sdk.references.ReferenceFileInput

Enhancement model used to marshall a file input.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "ReferenceFileInput",
   "description": "Enhancement model used to marshall a file input.",
   "type": "object",
   "properties": {
      "visibility": {
         "$ref": "#/$defs/Visibility",
         "default": "public",
         "description": "The level of visibility of the reference"
      },
      "identifiers": {
         "anyOf": [
            {
               "items": {
                  "discriminator": {
                     "mapping": {
                        "doi": "#/$defs/DOIIdentifier",
                        "open_alex": "#/$defs/OpenAlexIdentifier",
                        "other": "#/$defs/OtherIdentifier",
                        "pm_id": "#/$defs/PubMedIdentifier"
                     },
                     "propertyName": "identifier_type"
                  },
                  "oneOf": [
                     {
                        "$ref": "#/$defs/DOIIdentifier"
                     },
                     {
                        "$ref": "#/$defs/PubMedIdentifier"
                     },
                     {
                        "$ref": "#/$defs/OpenAlexIdentifier"
                     },
                     {
                        "$ref": "#/$defs/OtherIdentifier"
                     }
                  ]
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A list of `ExternalIdentifiers` for the Reference",
         "title": "Identifiers"
      },
      "enhancements": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/EnhancementFileInput"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A list of enhancements for the reference",
         "title": "Enhancements"
      }
   },
   "$defs": {
      "AbstractContentEnhancement": {
         "description": "An enhancement which is specific to the abstract of a reference.\n\nThis is separate from the `BibliographicMetadata` for two reasons:\n\n1. Abstracts are increasingly missing from sources like OpenAlex, and may be\nbackfilled from other sources, without the bibliographic metadata.\n2. They are also subject to copyright limitations in ways which metadata are\nnot, and thus need separate visibility controls.",
         "properties": {
            "enhancement_type": {
               "const": "abstract",
               "default": "abstract",
               "title": "Enhancement Type",
               "type": "string"
            },
            "process": {
               "$ref": "#/$defs/AbstractProcessType"
            },
            "abstract": {
               "description": "The abstract of the reference.",
               "title": "Abstract",
               "type": "string"
            }
         },
         "required": [
            "process",
            "abstract"
         ],
         "title": "AbstractContentEnhancement",
         "type": "object"
      },
      "AbstractProcessType": {
         "description": "The process used to acquire the abstract.",
         "enum": [
            "uninverted",
            "closed_api",
            "other"
         ],
         "title": "AbstractProcessType",
         "type": "string"
      },
      "AnnotationEnhancement": {
         "description": "An enhancement which is composed of a list of Annotations.",
         "properties": {
            "enhancement_type": {
               "const": "annotation",
               "default": "annotation",
               "title": "Enhancement Type",
               "type": "string"
            },
            "annotations": {
               "items": {
                  "discriminator": {
                     "mapping": {
                        "boolean": "#/$defs/BooleanAnnotation",
                        "score": "#/$defs/ScoreAnnotation"
                     },
                     "propertyName": "annotation_type"
                  },
                  "oneOf": [
                     {
                        "$ref": "#/$defs/BooleanAnnotation"
                     },
                     {
                        "$ref": "#/$defs/ScoreAnnotation"
                     }
                  ]
               },
               "minItems": 1,
               "title": "Annotations",
               "type": "array"
            }
         },
         "required": [
            "annotations"
         ],
         "title": "AnnotationEnhancement",
         "type": "object"
      },
      "AuthorPosition": {
         "description": "The position of an author in a list of authorships.\n\nMaps to the data from OpenAlex.",
         "enum": [
            "first",
            "middle",
            "last"
         ],
         "title": "AuthorPosition",
         "type": "string"
      },
      "Authorship": {
         "description": "Represents a single author and their association with a reference.\n\nThis is a simplification of the OpenAlex [Authorship\nobject](https://docs.openalex.org/api-entities/works/work-object/authorship-object)\nfor our purposes.",
         "properties": {
            "display_name": {
               "description": "The display name of the author.",
               "title": "Display Name",
               "type": "string"
            },
            "orcid": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ORCid of the author.",
               "title": "Orcid"
            },
            "position": {
               "$ref": "#/$defs/AuthorPosition",
               "description": "The position of the author within the list of authors."
            }
         },
         "required": [
            "display_name",
            "position"
         ],
         "title": "Authorship",
         "type": "object"
      },
      "BibliographicMetadataEnhancement": {
         "description": "An enhancement which is made up of bibliographic metadata.\n\nGenerally this will be sourced from a database such as OpenAlex or similar.\nFor directly contributed references, these may not be complete.",
         "properties": {
            "enhancement_type": {
               "const": "bibliographic",
               "default": "bibliographic",
               "title": "Enhancement Type",
               "type": "string"
            },
            "authorship": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Authorship"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of `Authorships` belonging to this reference.",
               "title": "Authorship"
            },
            "cited_by_count": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex) The number of citations to this work. These are the times that\nother works have cited this work\n",
               "title": "Cited By Count"
            },
            "created_date": {
               "anyOf": [
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ISO8601 date this metadata record was created",
               "title": "Created Date"
            },
            "publication_date": {
               "anyOf": [
                  {
                     "format": "date",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The date which the version of record was published.",
               "title": "Publication Date"
            },
            "publication_year": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The year in which the version of record was published.",
               "title": "Publication Year"
            },
            "publisher": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the entity which published the version of record.",
               "title": "Publisher"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The title of the reference.",
               "title": "Title"
            }
         },
         "title": "BibliographicMetadataEnhancement",
         "type": "object"
      },
      "BooleanAnnotation": {
         "description": "An annotation is a way of tagging the content with a label of some kind.\n\nThis class will probably be broken up in the future, but covers most of our\ninitial cases.",
         "properties": {
            "annotation_type": {
               "const": "boolean",
               "default": "boolean",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of the annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "value": {
               "description": "Boolean flag for this annotation",
               "title": "Value",
               "type": "boolean"
            },
            "score": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A confidence score for this annotation",
               "title": "Score"
            },
            "data": {
               "additionalProperties": true,
               "description": "\nAn object representation of the annotation including any confidence scores or\ndescriptions.\n",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "value"
         ],
         "title": "BooleanAnnotation",
         "type": "object"
      },
      "DOIIdentifier": {
         "description": "An external identifier representing a DOI.",
         "properties": {
            "identifier": {
               "description": "The DOI of the reference.",
               "pattern": "^10\\.\\d{4,9}/[-._;()/:a-zA-Z0-9%<>\\[\\]+&]+$",
               "title": "Identifier",
               "type": "string"
            },
            "identifier_type": {
               "const": "doi",
               "default": "doi",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            }
         },
         "required": [
            "identifier"
         ],
         "title": "DOIIdentifier",
         "type": "object"
      },
      "DriverVersion": {
         "description": "The version based on the DRIVER guidelines versioning scheme.\n\n(Borrowed from OpenAlex)",
         "enum": [
            "publishedVersion",
            "acceptedVersion",
            "submittedVersion",
            "other"
         ],
         "title": "DriverVersion",
         "type": "string"
      },
      "EnhancementFileInput": {
         "description": "Enhancement model used to marshall a file input to new references.",
         "properties": {
            "source": {
               "description": "The enhancement source for tracking provenance.",
               "title": "Source",
               "type": "string"
            },
            "visibility": {
               "$ref": "#/$defs/Visibility",
               "description": "The level of visibility of the enhancement"
            },
            "processor_version": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The version of the robot that generated the content.",
               "title": "Processor Version"
            },
            "content": {
               "description": "The content of the enhancement.",
               "discriminator": {
                  "mapping": {
                     "abstract": "#/$defs/AbstractContentEnhancement",
                     "annotation": "#/$defs/AnnotationEnhancement",
                     "bibliographic": "#/$defs/BibliographicMetadataEnhancement",
                     "location": "#/$defs/LocationEnhancement"
                  },
                  "propertyName": "enhancement_type"
               },
               "oneOf": [
                  {
                     "$ref": "#/$defs/BibliographicMetadataEnhancement"
                  },
                  {
                     "$ref": "#/$defs/AbstractContentEnhancement"
                  },
                  {
                     "$ref": "#/$defs/AnnotationEnhancement"
                  },
                  {
                     "$ref": "#/$defs/LocationEnhancement"
                  }
               ],
               "title": "Content"
            }
         },
         "required": [
            "source",
            "visibility",
            "content"
         ],
         "title": "EnhancementFileInput",
         "type": "object"
      },
      "Location": {
         "description": "A location where a reference can be found.\n\nThis maps almost completely to the OpenAlex\n[Location object](https://docs.openalex.org/api-entities/works/work-object/location-object)",
         "properties": {
            "is_oa": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): True if an Open Access (OA) version of this work is available\nat this location. May be left as null if this is unknown (and thus)\ntreated effectively as `false`.\n",
               "title": "Is Oa"
            },
            "version": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/DriverVersion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\nThe version (according to the DRIVER versioning scheme) of this location.\n"
            },
            "landing_page_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "(From OpenAlex): The landing page URL for this location.",
               "title": "Landing Page Url"
            },
            "pdf_url": {
               "anyOf": [
                  {
                     "format": "uri",
                     "maxLength": 2083,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): A URL where you can find this location as a PDF.\n",
               "title": "Pdf Url"
            },
            "license": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "\n(From OpenAlex): The location's publishing license. This can be a Creative\nCommons license such as cc0 or cc-by, a publisher-specific license, or null\nwhich means we are not able to determine a license for this location.\n",
               "title": "License"
            },
            "extra": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Any extra metadata about this location",
               "title": "Extra"
            }
         },
         "title": "Location",
         "type": "object"
      },
      "LocationEnhancement": {
         "description": "An enhancement which describes locations where this reference can be found.\n\nThis maps closely (almost exactly) to OpenAlex's locations.",
         "properties": {
            "enhancement_type": {
               "const": "location",
               "default": "location",
               "title": "Enhancement Type",
               "type": "string"
            },
            "locations": {
               "description": "A list of locations where this reference can be found.",
               "items": {
                  "$ref": "#/$defs/Location"
               },
               "minItems": 1,
               "title": "Locations",
               "type": "array"
            }
         },
         "required": [
            "locations"
         ],
         "title": "LocationEnhancement",
         "type": "object"
      },
      "OpenAlexIdentifier": {
         "description": "An external identifier representing an OpenAlex ID.",
         "properties": {
            "identifier": {
               "description": "The OpenAlex ID of the reference.",
               "pattern": "^W\\d+$",
               "title": "Identifier",
               "type": "string"
            },
            "identifier_type": {
               "const": "open_alex",
               "default": "open_alex",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            }
         },
         "required": [
            "identifier"
         ],
         "title": "OpenAlexIdentifier",
         "type": "object"
      },
      "OtherIdentifier": {
         "description": "An external identifier not otherwise defined by the repository.",
         "properties": {
            "identifier": {
               "description": "The identifier of the reference.",
               "title": "Identifier",
               "type": "string"
            },
            "identifier_type": {
               "const": "other",
               "default": "other",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            },
            "other_identifier_name": {
               "description": "The name of the undocumented identifier type.",
               "title": "Other Identifier Name",
               "type": "string"
            }
         },
         "required": [
            "identifier",
            "other_identifier_name"
         ],
         "title": "OtherIdentifier",
         "type": "object"
      },
      "PubMedIdentifier": {
         "description": "An external identifier representing a PubMed ID.",
         "properties": {
            "identifier": {
               "description": "The PubMed ID of the reference.",
               "title": "Identifier",
               "type": "integer"
            },
            "identifier_type": {
               "const": "pm_id",
               "default": "pm_id",
               "description": "The type of identifier used.",
               "title": "Identifier Type",
               "type": "string"
            }
         },
         "required": [
            "identifier"
         ],
         "title": "PubMedIdentifier",
         "type": "object"
      },
      "ScoreAnnotation": {
         "description": "An annotation which represents the score for a label.\n\nThis is similar to a BooleanAnnotation, but lacks a boolean determination\nas to the application of the label.",
         "properties": {
            "annotation_type": {
               "const": "score",
               "default": "score",
               "title": "Annotation Type",
               "type": "string"
            },
            "scheme": {
               "description": "An identifier for the scheme of annotation",
               "examples": [
                  "openalex:topic",
                  "pubmed:mesh"
               ],
               "title": "Scheme",
               "type": "string"
            },
            "label": {
               "description": "A high level label for this annotation like the name of the topic",
               "title": "Label",
               "type": "string"
            },
            "score": {
               "description": "Score for this annotation",
               "title": "Score",
               "type": "number"
            },
            "data": {
               "additionalProperties": true,
               "description": "An object representation of the annotation including any confidence scores or descriptions.",
               "title": "Data",
               "type": "object"
            }
         },
         "required": [
            "scheme",
            "label",
            "score"
         ],
         "title": "ScoreAnnotation",
         "type": "object"
      },
      "Visibility": {
         "description": "The visibility of a data element in the repository.\n\nThis is used to manage whether information should be publicly available or\nrestricted (generally due to copyright constraints from publishers).",
         "enum": [
            "public",
            "restricted",
            "hidden"
         ],
         "title": "Visibility",
         "type": "string"
      }
   }
}

Fields:

• enhancements (list[destiny_sdk.enhancements.EnhancementFileInput] | None)

• identifiers (list[destiny_sdk.identifiers.DOIIdentifier | destiny_sdk.identifiers.PubMedIdentifier | destiny_sdk.identifiers.OpenAlexIdentifier | destiny_sdk.identifiers.OtherIdentifier] | None)

• visibility (destiny_sdk.visibility.Visibility)

field enhancements: list[EnhancementFileInput] | None = None

A list of enhancements for the reference

field identifiers: list[Annotated[DOIIdentifier | PubMedIdentifier | OpenAlexIdentifier | OtherIdentifier, FieldInfo(annotation=NoneType, required=True, discriminator='identifier_type')]] | None = None

A list of ExternalIdentifiers for the Reference

field visibility: Visibility = Visibility.PUBLIC

The level of visibility of the reference

classmethod from_jsonl(jsonl: str) → Self

Create an object from a JSONL string.

Parameters:

jsonl (str) – The JSONL string to parse.

Returns:

The created object.

Return type:

Self

to_jsonl() → str

Convert the model to a JSONL string.

Returns:

The JSONL string representation of the model.

Return type:

str