Microsoft Outlook

OutlookLocalCalendarReader

基类: BaseReader

适用于 Windows 的 Outlook 本地日历阅读器。读取 Outlook 日历本地副本中的事件。

源代码位于 llama-index-integrations/readers/llama-index-readers-microsoft-outlook/llama_index/readers/microsoft_outlook/base.py

class OutlookLocalCalendarReader(BaseReader):
    """
    Outlook local calendar reader for Windows.
    Reads events from local copy of Outlook calendar.
    """

    def load_data(
        self,
        number_of_results: Optional[int] = 100,
        start_date: Optional[Union[str, datetime.date]] = None,
        end_date: Optional[Union[str, datetime.date]] = None,
        more_attributes: Optional[List[str]] = None,
    ) -> List[Document]:
        """
        Load data from user's local calendar.

        Args:
            number_of_results (Optional[int]): the number of events to return. Defaults to 100.
            start_date (Optional[Union[str, datetime.date]]): the start date to return events from. Defaults to today.
            end_date (Optional[Union[str, datetime.date]]): the last date (inclusive) to return events from. Defaults to 2199-01-01.
            more_attributes (Optional[ List[str]]): additional attributes to be retrieved from calendar entries. Non-existnat attributes are ignored.

        Returns a list of documents sutitable for indexing by llam_index. Always returns Start, End, Subject, Location, and Organizer
        attributes and optionally returns additional attributes specified in the more_attributes parameter.

        """
        if platform.system().lower() != "windows":
            return []
        attributes = [
            "Start",
            "End",
            "Subject",
            "Location",
            "Organizer",
        ]  # base attributes to return
        if more_attributes is not None:  # if the user has specified more attributes
            attributes += more_attributes
        if start_date is None:
            start_date = datetime.date.today()
        elif isinstance(start_date, str):
            start_date = datetime.date.fromisoformat(start_date)

        # Initialize the Outlook application
        winstuff = importlib.import_module("win32com.client")
        outlook = winstuff.Dispatch("Outlook.Application").GetNamespace("MAPI")

        # Get the Calendar folder
        calendar_folder = outlook.GetDefaultFolder(9)

        # Retrieve calendar items
        events = calendar_folder.Items

        if not events:
            return []
        events.Sort("[Start]")  # Sort items by start time
        numberReturned = 0
        results = []
        for event in events:
            converted_date = datetime.date(
                event.Start.year, event.Start.month, event.Start.day
            )
            if converted_date > start_date:  # if past start date
                numberReturned += 1
                eventstring = ""
                for attribute in attributes:
                    if hasattr(event, attribute):
                        eventstring += f"{attribute}: {getattr(event,attribute)}, "
                results.append(Document(text=eventstring))
            if numberReturned >= number_of_results:
                break

        return results

load_data

load_data(number_of_results: Optional[int] = 100, start_date: Optional[Union[str, date]] = None, end_date: Optional[Union[str, date]] = None, more_attributes: Optional[List[str]] = None) -> List[Document]

从用户的本地日历加载数据。

参数

名称	类型	描述	默认值
number_of_results	可选[int]	要返回的事件数量。默认值为 100。	100
start_date	可选[联合[str, date]]	返回事件的开始日期。默认为今天。	无
end_date	可选[联合[str, date]]	返回事件的最后日期（包含）。默认值为 2199-01-01。	无
more_attributes	可选[列表[str]]	要从日历条目中检索的附加属性。不存在的属性将被忽略。	无

返回适合由 llama_index 索引的文档列表。始终返回 Start、End、Subject、Location 和 Organizer 属性，并可选择返回 more_attributes 参数中指定的附加属性。

源代码位于 llama-index-integrations/readers/llama-index-readers-microsoft-outlook/llama_index/readers/microsoft_outlook/base.py

def load_data(
    self,
    number_of_results: Optional[int] = 100,
    start_date: Optional[Union[str, datetime.date]] = None,
    end_date: Optional[Union[str, datetime.date]] = None,
    more_attributes: Optional[List[str]] = None,
) -> List[Document]:
    """
    Load data from user's local calendar.

    Args:
        number_of_results (Optional[int]): the number of events to return. Defaults to 100.
        start_date (Optional[Union[str, datetime.date]]): the start date to return events from. Defaults to today.
        end_date (Optional[Union[str, datetime.date]]): the last date (inclusive) to return events from. Defaults to 2199-01-01.
        more_attributes (Optional[ List[str]]): additional attributes to be retrieved from calendar entries. Non-existnat attributes are ignored.

    Returns a list of documents sutitable for indexing by llam_index. Always returns Start, End, Subject, Location, and Organizer
    attributes and optionally returns additional attributes specified in the more_attributes parameter.

    """
    if platform.system().lower() != "windows":
        return []
    attributes = [
        "Start",
        "End",
        "Subject",
        "Location",
        "Organizer",
    ]  # base attributes to return
    if more_attributes is not None:  # if the user has specified more attributes
        attributes += more_attributes
    if start_date is None:
        start_date = datetime.date.today()
    elif isinstance(start_date, str):
        start_date = datetime.date.fromisoformat(start_date)

    # Initialize the Outlook application
    winstuff = importlib.import_module("win32com.client")
    outlook = winstuff.Dispatch("Outlook.Application").GetNamespace("MAPI")

    # Get the Calendar folder
    calendar_folder = outlook.GetDefaultFolder(9)

    # Retrieve calendar items
    events = calendar_folder.Items

    if not events:
        return []
    events.Sort("[Start]")  # Sort items by start time
    numberReturned = 0
    results = []
    for event in events:
        converted_date = datetime.date(
            event.Start.year, event.Start.month, event.Start.day
        )
        if converted_date > start_date:  # if past start date
            numberReturned += 1
            eventstring = ""
            for attribute in attributes:
                if hasattr(event, attribute):
                    eventstring += f"{attribute}: {getattr(event,attribute)}, "
            results.append(Document(text=eventstring))
        if numberReturned >= number_of_results:
            break

    return results