`rg.markdown`¶

为了支持在 Argilla 中使用 Markdown，我们创建了一些辅助函数，以便于使用 DataURL 转换和聊天消息可视化。

`media` ¶

`video_to_html(file_source, file_type=None, width=None, height=None, autoplay=False, loop=False)` ¶

将视频文件转换为带有嵌入 base64 数据的 HTML 标签。

参数

名称	类型	描述	默认值
`file_source`	`Union[str, bytes]`	媒体文件的路径或非 b64 编码的字节字符串。	必需
`file_type`	`Optional[str]`	视频文件的类型。如果未提供，将从文件扩展名推断。	`无`
`width`	`Optional[str]`	HTML 中显示的宽度。默认为 None。	`无`
`height`	`Optional[str]`	HTML 中显示的高度。默认为 None。	`无`
`autoplay`	`bool`	True 表示自动播放媒体。默认为 False。	`False`
`loop`	`bool`	True 表示循环播放媒体。默认为 False。	`False`

返回

类型	描述
`str`	带有嵌入 base64 数据的 HTML 标签。

示例

from argilla.markdown import video_to_html
html = video_to_html("my_video.mp4", width="300px", height="300px", autoplay=True, loop=True)

源代码在 src/argilla/markdown/media.py 中

def video_to_html(
    file_source: Union[str, bytes],
    file_type: Optional[str] = None,
    width: Optional[str] = None,
    height: Optional[str] = None,
    autoplay: bool = False,
    loop: bool = False,
) -> str:
    """
    Convert a video file to an HTML tag with embedded base64 data.

    Args:
        file_source: The path to the media file or a non-b64 encoded byte string.
        file_type: The type of the video file. If not provided, it will be inferred from the file extension.
        width: Display width in HTML. Defaults to None.
        height: Display height in HTML. Defaults to None.
        autoplay: True to autoplay media. Defaults to False.
        loop: True to loop media. Defaults to False.

    Returns:
        The HTML tag with embedded base64 data.

    Examples:
        ```python
        from argilla.markdown import video_to_html
        html = video_to_html("my_video.mp4", width="300px", height="300px", autoplay=True, loop=True)
        ```
    """
    return _media_to_html("video", file_source, file_type, width, height, autoplay, loop)

`audio_to_html(file_source, file_type=None, width=None, height=None, autoplay=False, loop=False)` ¶

将音频文件转换为带有嵌入 base64 数据的 HTML 标签。

参数

名称	类型	描述	默认值
`file_source`	`Union[str, bytes]`	媒体文件的路径或非 b64 编码的字节字符串。	必需
`file_type`	`Optional[str]`	音频文件的类型。如果未提供，将从文件扩展名推断。	`无`
`width`	`Optional[str]`	HTML 中显示的宽度。默认为 None。	`无`
`height`	`Optional[str]`	HTML 中显示的高度。默认为 None。	`无`
`autoplay`	`bool`	True 表示自动播放媒体。默认为 False。	`False`
`loop`	`bool`	True 表示循环播放媒体。默认为 False。	`False`

返回

类型	描述
`str`	带有嵌入 base64 数据的 HTML 标签。

示例

from argilla.markdown import audio_to_html
html = audio_to_html("my_audio.mp3", width="300px", height="300px", autoplay=True, loop=True)

源代码在 src/argilla/markdown/media.py 中

def audio_to_html(
    file_source: Union[str, bytes],
    file_type: Optional[str] = None,
    width: Optional[str] = None,
    height: Optional[str] = None,
    autoplay: bool = False,
    loop: bool = False,
) -> str:
    """
    Convert an audio file to an HTML tag with embedded base64 data.

    Args:
        file_source: The path to the media file or a non-b64 encoded byte string.
        file_type: The type of the audio file. If not provided, it will be inferred from the file extension.
        width: Display width in HTML. Defaults to None.
        height: Display height in HTML. Defaults to None.
        autoplay: True to autoplay media. Defaults to False.
        loop: True to loop media. Defaults to False.

    Returns:
        The HTML tag with embedded base64 data.

    Examples:
        ```python
        from argilla.markdown import audio_to_html
        html = audio_to_html("my_audio.mp3", width="300px", height="300px", autoplay=True, loop=True)
        ```
    """
    return _media_to_html("audio", file_source, file_type, width, height, autoplay, loop)

`image_to_html(file_source, file_type=None, width=None, height=None)` ¶

将图像文件转换为带有嵌入 base64 数据的 HTML 标签。

参数

名称	类型	描述	默认值
`file_source`	`Union[str, bytes]`	媒体文件的路径或非 b64 编码的字节字符串。	必需
`file_type`	`Optional[str]`	图像文件的类型。如果未提供，将从文件扩展名推断。	`无`
`width`	`Optional[str]`	HTML 中显示的宽度。默认为 None。	`无`
`height`	`Optional[str]`	HTML 中显示的高度。默认为 None。	`无`

返回

类型	描述
`str`	带有嵌入 base64 数据的 HTML 标签。

示例

from argilla.markdown import image_to_html
html = image_to_html("my_image.png", width="300px", height="300px")

源代码在 src/argilla/markdown/media.py 中

def image_to_html(
    file_source: Union[str, bytes],
    file_type: Optional[str] = None,
    width: Optional[str] = None,
    height: Optional[str] = None,
) -> str:
    """
    Convert an image file to an HTML tag with embedded base64 data.

    Args:
        file_source: The path to the media file or a non-b64 encoded byte string.
        file_type: The type of the image file. If not provided, it will be inferred from the file extension.
        width: Display width in HTML. Defaults to None.
        height: Display height in HTML. Defaults to None.

    Returns:
        The HTML tag with embedded base64 data.

    Examples:
        ```python
        from argilla.markdown import image_to_html
        html = image_to_html("my_image.png", width="300px", height="300px")
        ```
    """
    return _media_to_html("image", file_source, file_type, width, height)

`pdf_to_html(file_source, width='1000px', height='1000px')` ¶

将 pdf 文件转换为带有嵌入数据的 HTML 标签。

参数

名称	类型	描述	默认值
`file_source`	`Union[str, bytes]`	PDF 文件的路径，包含 PDF 数据的字节对象，或 URL。	必需
`width`	`Optional[str]`	HTML 中显示的宽度。默认为 "1000px"。	`'1000px'`
`height`	`Optional[str]`	HTML 中显示的高度。默认为 "1000px"。	`'1000px'`

返回

类型	描述
`str`	嵌入 PDF 的 HTML 字符串。

引发

类型	描述
`ValueError`	如果宽度和高度不是像素或百分比。

示例

from argilla.markdown import pdf_to_html
html = pdf_to_html("my_pdf.pdf", width="300px", height="300px")

源代码在 src/argilla/markdown/media.py 中

def pdf_to_html(
    file_source: Union[str, bytes], width: Optional[str] = "1000px", height: Optional[str] = "1000px"
) -> str:
    """
    Convert a pdf file to an HTML tag with embedded data.

    Args:
        file_source: The path to the PDF file, a bytes object with PDF data, or a URL.
        width: Display width in HTML. Defaults to "1000px".
        height: Display height in HTML. Defaults to "1000px".

    Returns:
        HTML string embedding the PDF.

    Raises:
        ValueError: If the width and height are not pixel or percentage.

    Examples:
        ```python
        from argilla.markdown import pdf_to_html
        html = pdf_to_html("my_pdf.pdf", width="300px", height="300px")
        ```
    """
    if not _is_valid_dimension(width) or not _is_valid_dimension(height):
        raise ValueError("Width and height must be valid pixel (e.g., '300px') or percentage (e.g., '50%') values.")

    if isinstance(file_source, str) and urlparse(file_source).scheme in ["http", "https"]:
        return f'<embed src="{file_source}" type="application/pdf" width="{width}" height="{height}"></embed>'

    file_data, _ = _get_file_data(file_source, "pdf")
    pdf_base64 = base64.b64encode(file_data).decode("utf-8")
    data_url = f"data:application/pdf;base64,{pdf_base64}"
    return f'<object id="pdf" data="{data_url}" type="application/pdf" width="{width}" height="{height}"></object>'

`chat` ¶

`chat_to_html(messages)` ¶

将 OpenAI 格式的聊天消息列表转换为 HTML。

参数

名称	类型	描述	默认值
`messages`	`List[Dict[str, str]]`	字典列表，其中每个字典代表一条聊天消息。每个字典应具有以下键：- "role"：一个字符串，指示发送者的角色（例如，“user”、“model”、“assistant”、“system”）。- "content"：消息的内容。	必需

返回

名称	类型	描述
`str`	`str`	表示聊天对话的 HTML 字符串。

引发

类型	描述
`ValueError`	如果传递了无效的角色。

示例

from argilla.markdown import chat_to_html
html = chat_to_html([
    {"role": "user", "content": "hello"},
    {"role": "assistant", "content": "goodbye"}
])

源代码在 src/argilla/markdown/chat.py 中

def chat_to_html(messages: List[Dict[str, str]]) -> str:
    """
    Converts a list of chat messages in the OpenAI format to HTML.

    Args:
        messages (List[Dict[str, str]]): A list of dictionaries where each dictionary represents a chat message.
            Each dictionary should have the keys:
                - "role": A string indicating the role of the sender (e.g., "user", "model", "assistant", "system").
                - "content": The content of the message.

    Returns:
        str: An HTML string that represents the chat conversation.

    Raises:
        ValueError: If the an invalid role is passed.

    Examples:
        ```python
        from argilla.markdown import chat_to_html
        html = chat_to_html([
            {"role": "user", "content": "hello"},
            {"role": "assistant", "content": "goodbye"}
        ])
        ```
    """
    chat_html = ""
    for message in messages:
        role = message["role"]
        content = message["content"]
        content_html = markdown.markdown(content)

        if role == "user":
            html = '<div class="user-message">' + '<div class="message-content">'
        elif role in ["model", "assistant", "system"]:
            html = '<div class="system-message">' + '<div class="message-content">'
        else:
            raise ValueError(f"Invalid role: {role}")

        html += f"{content_html}"
        html += "</div></div>"
        chat_html += html

    return f"<body>{CHAT_CSS_STYLE}{chat_html}</body>"

rg.markdown¶

media ¶

video_to_html(file_source, file_type=None, width=None, height=None, autoplay=False, loop=False) ¶

audio_to_html(file_source, file_type=None, width=None, height=None, autoplay=False, loop=False) ¶

image_to_html(file_source, file_type=None, width=None, height=None) ¶

pdf_to_html(file_source, width='1000px', height='1000px') ¶

chat ¶

chat_to_html(messages) ¶

`rg.markdown`¶

`media` ¶

`video_to_html(file_source, file_type=None, width=None, height=None, autoplay=False, loop=False)` ¶

`audio_to_html(file_source, file_type=None, width=None, height=None, autoplay=False, loop=False)` ¶

`image_to_html(file_source, file_type=None, width=None, height=None)` ¶

`pdf_to_html(file_source, width='1000px', height='1000px')` ¶

`chat` ¶

`chat_to_html(messages)` ¶