perceptic-core-client 0.29.0__py3-none-any.whl → 0.31.0__py3-none-any.whl

perceptic_core_client/models/biotech_analysis_api_dto.py

@@ -0,0 +1,119 @@
+# coding: utf-8
+
+"""
+    perceptic-core-server API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.0.1-SNAPSHOT
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from perceptic_core_client.models.image_detection_box_api_dto import ImageDetectionBoxApiDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BiotechAnalysisApiDto(BaseModel):
+    """
+    BiotechAnalysisApiDto
+    """ # noqa: E501
+    raw_analysis: Optional[StrictStr] = Field(default=None, alias="rawAnalysis")
+    compound_data_present: Optional[StrictBool] = Field(default=None, alias="compoundDataPresent")
+    compounds: Optional[List[StrictStr]] = None
+    development_stage: Optional[StrictStr] = Field(default=None, alias="developmentStage")
+    therapeutic_area: Optional[StrictStr] = Field(default=None, alias="therapeuticArea")
+    key_findings: Optional[List[StrictStr]] = Field(default=None, alias="keyFindings")
+    risks: Optional[List[StrictStr]] = None
+    market_potential: Optional[StrictStr] = Field(default=None, alias="marketPotential")
+    confidence: Optional[Union[StrictFloat, StrictInt]] = None
+    reasoning: Optional[StrictStr] = None
+    bounding_boxes: Optional[List[ImageDetectionBoxApiDto]] = Field(default=None, alias="boundingBoxes")
+    page_index: Optional[StrictInt] = Field(default=None, alias="pageIndex")
+    character_count: Optional[StrictInt] = Field(default=None, alias="characterCount")
+    __properties: ClassVar[List[str]] = ["rawAnalysis", "compoundDataPresent", "compounds", "developmentStage", "therapeuticArea", "keyFindings", "risks", "marketPotential", "confidence", "reasoning", "boundingBoxes", "pageIndex", "characterCount"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of BiotechAnalysisApiDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in bounding_boxes (list)
+        _items = []
+        if self.bounding_boxes:
+            for _item_bounding_boxes in self.bounding_boxes:
+                if _item_bounding_boxes:
+                    _items.append(_item_bounding_boxes.to_dict())
+            _dict['boundingBoxes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BiotechAnalysisApiDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "rawAnalysis": obj.get("rawAnalysis"),
+            "compoundDataPresent": obj.get("compoundDataPresent"),
+            "compounds": obj.get("compounds"),
+            "developmentStage": obj.get("developmentStage"),
+            "therapeuticArea": obj.get("therapeuticArea"),
+            "keyFindings": obj.get("keyFindings"),
+            "risks": obj.get("risks"),
+            "marketPotential": obj.get("marketPotential"),
+            "confidence": obj.get("confidence"),
+            "reasoning": obj.get("reasoning"),
+            "boundingBoxes": [ImageDetectionBoxApiDto.from_dict(_item) for _item in obj["boundingBoxes"]] if obj.get("boundingBoxes") is not None else None,
+            "pageIndex": obj.get("pageIndex"),
+            "characterCount": obj.get("characterCount")
+        })
+        return _obj
+
+

perceptic_core_client/models/biotech_analysis_image_annotated_citation_api_dto.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    perceptic-core-server API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.0.1-SNAPSHOT
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from perceptic_core_client.models.biotech_analysis_api_dto import BiotechAnalysisApiDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BiotechAnalysisImageAnnotatedCitationApiDto(BaseModel):
+    """
+    BiotechAnalysisImageAnnotatedCitationApiDto
+    """ # noqa: E501
+    analysis: Optional[BiotechAnalysisApiDto] = None
+    __properties: ClassVar[List[str]] = ["analysis"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of BiotechAnalysisImageAnnotatedCitationApiDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of analysis
+        if self.analysis:
+            _dict['analysis'] = self.analysis.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BiotechAnalysisImageAnnotatedCitationApiDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "analysis": BiotechAnalysisApiDto.from_dict(obj["analysis"]) if obj.get("analysis") is not None else None
+        })
+        return _obj
+
+

perceptic_core_client/models/bulk_get_citations_request.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    perceptic-core-server API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.0.1-SNAPSHOT
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkGetCitationsRequest(BaseModel):
+    """
+    BulkGetCitationsRequest
+    """ # noqa: E501
+    ids: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["ids"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of BulkGetCitationsRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BulkGetCitationsRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ids": obj.get("ids")
+        })
+        return _obj
+
+

perceptic_core_client/models/bulk_get_citations_response.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    perceptic-core-server API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.0.1-SNAPSHOT
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from perceptic_core_client.models.citation_api_dto import CitationApiDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkGetCitationsResponse(BaseModel):
+    """
+    BulkGetCitationsResponse
+    """ # noqa: E501
+    citations: Optional[List[CitationApiDto]] = None
+    __properties: ClassVar[List[str]] = ["citations"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of BulkGetCitationsResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in citations (list)
+        _items = []
+        if self.citations:
+            for _item_citations in self.citations:
+                if _item_citations:
+                    _items.append(_item_citations.to_dict())
+            _dict['citations'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BulkGetCitationsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "citations": [CitationApiDto.from_dict(_item) for _item in obj["citations"]] if obj.get("citations") is not None else None
+        })
+        return _obj
+
+

perceptic_core_client/models/citation_api_dto.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    perceptic-core-server API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.0.1-SNAPSHOT
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from perceptic_core_client.models.citation_metadata_api_dto import CitationMetadataApiDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CitationApiDto(BaseModel):
+    """
+    CitationApiDto
+    """ # noqa: E501
+    id: Optional[StrictStr] = None
+    input_uri: Optional[StrictStr] = Field(default=None, alias="inputUri")
+    output_artifact_uri: Optional[StrictStr] = Field(default=None, alias="outputArtifactUri")
+    metadata: Optional[CitationMetadataApiDto] = None
+    __properties: ClassVar[List[str]] = ["id", "inputUri", "outputArtifactUri", "metadata"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CitationApiDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of metadata
+        if self.metadata:
+            _dict['metadata'] = self.metadata.to_dict()
+        # set to None if output_artifact_uri (nullable) is None
+        # and model_fields_set contains the field
+        if self.output_artifact_uri is None and "output_artifact_uri" in self.model_fields_set:
+            _dict['outputArtifactUri'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CitationApiDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "inputUri": obj.get("inputUri"),
+            "outputArtifactUri": obj.get("outputArtifactUri"),
+            "metadata": CitationMetadataApiDto.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None
+        })
+        return _obj
+
+

perceptic_core_client/models/citation_metadata_api_dto.py

@@ -0,0 +1,189 @@
+# coding: utf-8
+
+"""
+    perceptic-core-server API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.0.1-SNAPSHOT
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from perceptic_core_client.models.biotech_analysis_image_annotated_citation_api_dto import BiotechAnalysisImageAnnotatedCitationApiDto
+from perceptic_core_client.models.highlighted_text_citation_metadata_api_dto import HighlightedTextCitationMetadataApiDto
+from perceptic_core_client.models.web_page_citation_metadata_api_dto import WebPageCitationMetadataApiDto
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+CITATIONMETADATAAPIDTO_ONE_OF_SCHEMAS = ["BiotechAnalysisImageAnnotatedCitationApiDto", "HighlightedTextCitationMetadataApiDto", "WebPageCitationMetadataApiDto"]
+
+class CitationMetadataApiDto(BaseModel):
+    """
+    CitationMetadataApiDto
+    """
+    # data type: HighlightedTextCitationMetadataApiDto
+    oneof_schema_1_validator: Optional[HighlightedTextCitationMetadataApiDto] = None
+    # data type: WebPageCitationMetadataApiDto
+    oneof_schema_2_validator: Optional[WebPageCitationMetadataApiDto] = None
+    # data type: BiotechAnalysisImageAnnotatedCitationApiDto
+    oneof_schema_3_validator: Optional[BiotechAnalysisImageAnnotatedCitationApiDto] = None
+    actual_instance: Optional[Union[BiotechAnalysisImageAnnotatedCitationApiDto, HighlightedTextCitationMetadataApiDto, WebPageCitationMetadataApiDto]] = None
+    one_of_schemas: Set[str] = { "BiotechAnalysisImageAnnotatedCitationApiDto", "HighlightedTextCitationMetadataApiDto", "WebPageCitationMetadataApiDto" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    discriminator_value_class_map: Dict[str, str] = {
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = CitationMetadataApiDto.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: HighlightedTextCitationMetadataApiDto
+        if not isinstance(v, HighlightedTextCitationMetadataApiDto):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `HighlightedTextCitationMetadataApiDto`")
+        else:
+            match += 1
+        # validate data type: WebPageCitationMetadataApiDto
+        if not isinstance(v, WebPageCitationMetadataApiDto):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `WebPageCitationMetadataApiDto`")
+        else:
+            match += 1
+        # validate data type: BiotechAnalysisImageAnnotatedCitationApiDto
+        if not isinstance(v, BiotechAnalysisImageAnnotatedCitationApiDto):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `BiotechAnalysisImageAnnotatedCitationApiDto`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in CitationMetadataApiDto with oneOf schemas: BiotechAnalysisImageAnnotatedCitationApiDto, HighlightedTextCitationMetadataApiDto, WebPageCitationMetadataApiDto. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in CitationMetadataApiDto with oneOf schemas: BiotechAnalysisImageAnnotatedCitationApiDto, HighlightedTextCitationMetadataApiDto, WebPageCitationMetadataApiDto. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # use oneOf discriminator to lookup the data type
+        _data_type = json.loads(json_str).get("type")
+        if not _data_type:
+            raise ValueError("Failed to lookup data type from the field `type` in the input.")
+
+        # check if data type is `AnnotatedImageCitationMetadataApiDto`
+        if _data_type == "annotated-image":
+            instance.actual_instance = AnnotatedImageCitationMetadataApiDto.from_json(json_str)
+            return instance
+
+        # check if data type is `HighlightedTextCitationMetadataApiDto`
+        if _data_type == "highlighted-text":
+            instance.actual_instance = HighlightedTextCitationMetadataApiDto.from_json(json_str)
+            return instance
+
+        # check if data type is `WebPageCitationMetadataApiDto`
+        if _data_type == "web-page":
+            instance.actual_instance = WebPageCitationMetadataApiDto.from_json(json_str)
+            return instance
+
+        # check if data type is `AnnotatedImageCitationMetadataApiDto`
+        if _data_type == "AnnotatedImageCitationMetadataApiDto":
+            instance.actual_instance = AnnotatedImageCitationMetadataApiDto.from_json(json_str)
+            return instance
+
+        # check if data type is `HighlightedTextCitationMetadataApiDto`
+        if _data_type == "HighlightedTextCitationMetadataApiDto":
+            instance.actual_instance = HighlightedTextCitationMetadataApiDto.from_json(json_str)
+            return instance
+
+        # check if data type is `WebPageCitationMetadataApiDto`
+        if _data_type == "WebPageCitationMetadataApiDto":
+            instance.actual_instance = WebPageCitationMetadataApiDto.from_json(json_str)
+            return instance
+
+        # deserialize data into HighlightedTextCitationMetadataApiDto
+        try:
+            instance.actual_instance = HighlightedTextCitationMetadataApiDto.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into WebPageCitationMetadataApiDto
+        try:
+            instance.actual_instance = WebPageCitationMetadataApiDto.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into BiotechAnalysisImageAnnotatedCitationApiDto
+        try:
+            instance.actual_instance = BiotechAnalysisImageAnnotatedCitationApiDto.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into CitationMetadataApiDto with oneOf schemas: BiotechAnalysisImageAnnotatedCitationApiDto, HighlightedTextCitationMetadataApiDto, WebPageCitationMetadataApiDto. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into CitationMetadataApiDto with oneOf schemas: BiotechAnalysisImageAnnotatedCitationApiDto, HighlightedTextCitationMetadataApiDto, WebPageCitationMetadataApiDto. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], BiotechAnalysisImageAnnotatedCitationApiDto, HighlightedTextCitationMetadataApiDto, WebPageCitationMetadataApiDto]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+