wehub-resource-sync
94 lines
3.5 KiB
Python
94 lines
3.5 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
import logging
|
|
from enum import Enum
|
|
from typing import Any, ClassVar, Literal, TypeVar
|
|
from xml.etree.ElementTree import Element # nosec
|
|
|
|
from pydantic import ConfigDict, Field
|
|
|
|
from semantic_kernel.contents.const import ANNOTATION_CONTENT_TAG, ContentTypes
|
|
from semantic_kernel.contents.kernel_content import KernelContent
|
|
from semantic_kernel.utils.feature_stage_decorator import experimental
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
_T = TypeVar("_T", bound="AnnotationContent")
|
|
|
|
|
|
@experimental
|
|
class CitationType(str, Enum):
|
|
"""Citation type."""
|
|
|
|
URL_CITATION = "url_citation"
|
|
FILE_PATH = "file_path"
|
|
FILE_CITATION = "file_citation"
|
|
CONTAINER_FILE_CITATION = "container_file_citation"
|
|
|
|
|
|
@experimental
|
|
class AnnotationContent(KernelContent):
|
|
"""Annotation content."""
|
|
|
|
content_type: Literal[ContentTypes.ANNOTATION_CONTENT] = Field(ANNOTATION_CONTENT_TAG, init=False) # type: ignore
|
|
tag: ClassVar[str] = ANNOTATION_CONTENT_TAG
|
|
file_id: str | None = None
|
|
quote: str | None = None
|
|
start_index: int | None = None
|
|
end_index: int | None = None
|
|
url: str | None = None
|
|
title: str | None = None
|
|
citation_type: CitationType | None = Field(None, alias="type")
|
|
container_id: str | None = None
|
|
filename: str | None = None
|
|
|
|
model_config = ConfigDict(
|
|
extra="ignore",
|
|
populate_by_name=True,
|
|
)
|
|
|
|
def __str__(self) -> str:
|
|
"""Return the string representation of the annotation content."""
|
|
ctype = self.citation_type.value if self.citation_type else None
|
|
return f"AnnotationContent(type={ctype}, file_id={self.file_id}, url={self.url}, quote={self.quote}, start_index={self.start_index}, end_index={self.end_index})" # noqa: E501
|
|
|
|
def to_element(self) -> Element:
|
|
"""Convert the annotation content to an Element."""
|
|
element = Element(self.tag)
|
|
if self.citation_type:
|
|
element.set("type", self.citation_type)
|
|
if self.file_id:
|
|
element.set("file_id", self.file_id)
|
|
if self.quote:
|
|
element.set("quote", self.quote)
|
|
if self.start_index is not None:
|
|
element.set("start_index", str(self.start_index))
|
|
if self.end_index is not None:
|
|
element.set("end_index", str(self.end_index))
|
|
if self.url is not None:
|
|
element.set("url", self.url)
|
|
if self.title is not None:
|
|
element.set("title", self.title)
|
|
return element
|
|
|
|
@classmethod
|
|
def from_element(cls: type[_T], element: Element) -> _T:
|
|
"""Create an instance from an Element."""
|
|
return cls(
|
|
type=element.get("type"),
|
|
file_id=element.get("file_id"),
|
|
quote=element.get("quote"),
|
|
start_index=int(element.get("start_index")) if element.get("start_index") else None, # type: ignore
|
|
end_index=int(element.get("end_index")) if element.get("end_index") else None, # type: ignore
|
|
url=element.get("url") if element.get("url") else None, # type: ignore
|
|
title=element.get("title") if element.get("title") else None, # type: ignore
|
|
)
|
|
|
|
def to_dict(self) -> dict[str, Any]:
|
|
"""Convert the instance to a dictionary."""
|
|
ctype = self.citation_type.value if self.citation_type else None
|
|
return {
|
|
"type": "text",
|
|
"text": f"type={ctype}, {self.file_id or self.url} {self.quote} (Start Index={self.start_index}->End Index={self.end_index})", # noqa: E501
|
|
}
|