Reddit

RedditReader

Bases: BaseReader

Subreddit post and top-level comments reader for Reddit.

Source code in llama-index-integrations/readers/llama-index-readers-reddit/llama_index/readers/reddit/base.py

class RedditReader(BaseReader):
    """
    Subreddit post and top-level comments reader for Reddit.
    """

    def load_data(
        self,
        subreddits: List[str],
        search_keys: List[str],
        post_limit: Optional[int] = [10],
    ) -> List[Document]:
        """
        Load text from relevant posts and top-level comments in subreddit(s), given keyword(s) for search.

        Args:
            subreddits (List[str]): List of subreddits you'd like to read from
            search_keys (List[str]): List of keywords you'd like to use to search from subreddit(s)
            post_limit (Optional[int]): Maximum number of posts per subreddit you'd like to read from, defaults to 10

        """
        import os

        import praw
        from praw.models import MoreComments

        reddit = praw.Reddit(
            client_id=os.getenv("REDDIT_CLIENT_ID"),
            client_secret=os.getenv("REDDIT_CLIENT_SECRET"),
            user_agent=os.getenv("REDDIT_USER_AGENT"),
            username=os.getenv("REDDIT_USERNAME"),
            password=os.getenv("REDDIT_PASSWORD"),
        )

        posts = []

        for sr in subreddits:
            ml_subreddit = reddit.subreddit(sr)

            for kw in search_keys:
                relevant_posts = ml_subreddit.search(kw, limit=post_limit)

                for post in relevant_posts:
                    posts.append(Document(text=post.selftext))
                    for top_level_comment in post.comments:
                        if isinstance(top_level_comment, MoreComments):
                            continue
                        posts.append(Document(text=top_level_comment.body))

        return posts

load_data

load_data(subreddits: List[str], search_keys: List[str], post_limit: Optional[int] = [10]) -> List[Document]

Load text from relevant posts and top-level comments in subreddit(s), given keyword(s) for search.

Parameters:

Name	Type	Description	Default
subreddits	List[str]	List of subreddits you'd like to read from	required
search_keys	List[str]	List of keywords you'd like to use to search from subreddit(s)	required
post_limit	Optional[int]	Maximum number of posts per subreddit you'd like to read from, defaults to 10	[10]

Source code in llama-index-integrations/readers/llama-index-readers-reddit/llama_index/readers/reddit/base.py

def load_data(
    self,
    subreddits: List[str],
    search_keys: List[str],
    post_limit: Optional[int] = [10],
) -> List[Document]:
    """
    Load text from relevant posts and top-level comments in subreddit(s), given keyword(s) for search.

    Args:
        subreddits (List[str]): List of subreddits you'd like to read from
        search_keys (List[str]): List of keywords you'd like to use to search from subreddit(s)
        post_limit (Optional[int]): Maximum number of posts per subreddit you'd like to read from, defaults to 10

    """
    import os

    import praw
    from praw.models import MoreComments

    reddit = praw.Reddit(
        client_id=os.getenv("REDDIT_CLIENT_ID"),
        client_secret=os.getenv("REDDIT_CLIENT_SECRET"),
        user_agent=os.getenv("REDDIT_USER_AGENT"),
        username=os.getenv("REDDIT_USERNAME"),
        password=os.getenv("REDDIT_PASSWORD"),
    )

    posts = []

    for sr in subreddits:
        ml_subreddit = reddit.subreddit(sr)

        for kw in search_keys:
            relevant_posts = ml_subreddit.search(kw, limit=post_limit)

            for post in relevant_posts:
                posts.append(Document(text=post.selftext))
                for top_level_comment in post.comments:
                    if isinstance(top_level_comment, MoreComments):
                        continue
                    posts.append(Document(text=top_level_comment.body))

    return posts