id
stringlengths
14
15
text
stringlengths
35
2.51k
source
stringlengths
61
154
41b144249056-0
langchain.document_loaders.dataframe.DataFrameLoader¶ class langchain.document_loaders.dataframe.DataFrameLoader(data_frame: Any, page_content_column: str = 'text')[source]¶ Bases: BaseLoader Load Pandas DataFrames. Initialize with dataframe object. Methods __init__(data_frame[, page_content_column]) Initialize with da...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.dataframe.DataFrameLoader.html
960455d99848-0
langchain.document_loaders.html.UnstructuredHTMLLoader¶ class langchain.document_loaders.html.UnstructuredHTMLLoader(file_path: Union[str, List[str]], mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load HTML files. Initialize with file path. Met...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.html.UnstructuredHTMLLoader.html
f7364462e6f3-0
langchain.document_loaders.reddit.RedditPostsLoader¶ class langchain.document_loaders.reddit.RedditPostsLoader(client_id: str, client_secret: str, user_agent: str, search_queries: Sequence[str], mode: str, categories: Sequence[str] = ['new'], number_posts: Optional[int] = 10)[source]¶ Bases: BaseLoader Reddit posts loa...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.reddit.RedditPostsLoader.html
548af43dbf80-0
langchain.document_loaders.youtube.YoutubeLoader¶ class langchain.document_loaders.youtube.YoutubeLoader(video_id: str, add_video_info: bool = False, language: Union[str, Sequence[str]] = 'en', translation: str = 'en', continue_on_failure: bool = False)[source]¶ Bases: BaseLoader Loader that loads Youtube transcripts. ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.youtube.YoutubeLoader.html
f7c95b00aa55-0
langchain.document_loaders.youtube.GoogleApiYoutubeLoader¶ class langchain.document_loaders.youtube.GoogleApiYoutubeLoader(google_api_client: GoogleApiClient, channel_name: Optional[str] = None, video_ids: Optional[List[str]] = None, add_video_info: bool = True, captions_language: str = 'en', continue_on_failure: bool ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.youtube.GoogleApiYoutubeLoader.html
f7c95b00aa55-1
load() → List[Document][source]¶ Load documents. load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]¶ Load documents and split into chunks. classmethod validate_channel_or_videoIds_is_set(values: Dict[str, Any]) → Dict[str, Any][source]¶ Validate that either folder_id or document_ids is set, b...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.youtube.GoogleApiYoutubeLoader.html
de1d3bd7acbb-0
langchain.document_loaders.mastodon.MastodonTootsLoader¶ class langchain.document_loaders.mastodon.MastodonTootsLoader(mastodon_accounts: Sequence[str], number_toots: Optional[int] = 100, exclude_replies: bool = False, access_token: Optional[str] = None, api_base_url: str = 'https://mastodon.social')[source]¶ Bases: Ba...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.mastodon.MastodonTootsLoader.html
6155679c9ddc-0
langchain.document_loaders.pyspark_dataframe.PySparkDataFrameLoader¶ class langchain.document_loaders.pyspark_dataframe.PySparkDataFrameLoader(spark_session: Optional[SparkSession] = None, df: Optional[Any] = None, page_content_column: str = 'text', fraction_of_memory: float = 0.1)[source]¶ Bases: BaseLoader Load PySpa...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.pyspark_dataframe.PySparkDataFrameLoader.html
65fc14bd1f9f-0
langchain.document_loaders.word_document.UnstructuredWordDocumentLoader¶ class langchain.document_loaders.word_document.UnstructuredWordDocumentLoader(file_path: Union[str, List[str]], mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load word doc...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.word_document.UnstructuredWordDocumentLoader.html
c78e219c3d90-0
langchain.document_loaders.sitemap.SitemapLoader¶ class langchain.document_loaders.sitemap.SitemapLoader(web_path: str, filter_urls: Optional[List[str]] = None, parsing_function: Optional[Callable] = None, blocksize: Optional[int] = None, blocknum: int = 0, meta_function: Optional[Callable] = None, is_local: bool = Fal...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.sitemap.SitemapLoader.html
c78e219c3d90-1
scrape_all(urls[, parser]) Fetch all urls, then return soups for all results. Attributes bs_get_text_kwargs kwargs for beatifulsoup4 get_text default_parser Default parser to use for BeautifulSoup. raise_for_status Raise an exception if http status code denotes an error. requests_kwargs kwargs for requests requests_per...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.sitemap.SitemapLoader.html
c78e219c3d90-2
Max number of concurrent requests to make. property web_path: str¶ web_paths: List[str]¶
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.sitemap.SitemapLoader.html
6a4ad28a5a67-0
langchain.document_loaders.unstructured.UnstructuredAPIFileLoader¶ class langchain.document_loaders.unstructured.UnstructuredAPIFileLoader(file_path: Union[str, List[str]] = '', mode: str = 'single', url: str = 'https://api.unstructured.io/general/v0/general', api_key: str = '', **unstructured_kwargs: Any)[source]¶ Bas...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.unstructured.UnstructuredAPIFileLoader.html
f2917aecf763-0
langchain.document_loaders.markdown.UnstructuredMarkdownLoader¶ class langchain.document_loaders.markdown.UnstructuredMarkdownLoader(file_path: Union[str, List[str]], mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load markdown files. Initialize...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.markdown.UnstructuredMarkdownLoader.html
a7d79785ca1a-0
langchain.document_loaders.weather.WeatherDataLoader¶ class langchain.document_loaders.weather.WeatherDataLoader(client: OpenWeatherMapAPIWrapper, places: Sequence[str])[source]¶ Bases: BaseLoader Weather Reader. Reads the forecast & current weather of any location using OpenWeatherMap’s free API. Checkout ‘https://ope...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.weather.WeatherDataLoader.html
30f6aab4afee-0
langchain.document_loaders.twitter.TwitterTweetLoader¶ class langchain.document_loaders.twitter.TwitterTweetLoader(auth_handler: Union[OAuthHandler, OAuth2BearerHandler], twitter_users: Sequence[str], number_tweets: Optional[int] = 100)[source]¶ Bases: BaseLoader Twitter tweets loader. Read tweets of user twitter handl...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.twitter.TwitterTweetLoader.html
2df5376fa875-0
langchain.document_loaders.parsers.pdf.PyPDFParser¶ class langchain.document_loaders.parsers.pdf.PyPDFParser(password: Optional[Union[str, bytes]] = None)[source]¶ Bases: BaseBlobParser Loads a PDF with pypdf and chunks at character level. Methods __init__([password]) lazy_parse(blob) Lazily parse the blob. parse(blob)...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.parsers.pdf.PyPDFParser.html
2ba0b334614a-0
langchain.document_loaders.parsers.language.javascript.JavaScriptSegmenter¶ class langchain.document_loaders.parsers.language.javascript.JavaScriptSegmenter(code: str)[source]¶ Bases: CodeSegmenter Methods __init__(code) extract_functions_classes() is_valid() simplify_code() extract_functions_classes() → List[str][sour...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.parsers.language.javascript.JavaScriptSegmenter.html
0dbae2694c45-0
langchain.document_loaders.conllu.CoNLLULoader¶ class langchain.document_loaders.conllu.CoNLLULoader(file_path: str)[source]¶ Bases: BaseLoader Load CoNLL-U files. Initialize with file path. Methods __init__(file_path) Initialize with file path. lazy_load() A lazy loader for document content. load() Load from file path...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.conllu.CoNLLULoader.html
b1b705992751-0
langchain.document_loaders.notebook.NotebookLoader¶ class langchain.document_loaders.notebook.NotebookLoader(path: str, include_outputs: bool = False, max_output_length: int = 10, remove_newline: bool = False, traceback: bool = False)[source]¶ Bases: BaseLoader Loader that loads .ipynb notebook files. Initialize with p...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.notebook.NotebookLoader.html
bab16791de86-0
langchain.document_loaders.psychic.PsychicLoader¶ class langchain.document_loaders.psychic.PsychicLoader(api_key: str, account_id: str, connector_id: Optional[str] = None)[source]¶ Bases: BaseLoader Loader that loads documents from Psychic.dev. Initialize with API key, connector id, and account id. Methods __init__(api...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.psychic.PsychicLoader.html
c9b4d4426411-0
langchain.document_loaders.max_compute.MaxComputeLoader¶ class langchain.document_loaders.max_compute.MaxComputeLoader(query: str, api_wrapper: MaxComputeAPIWrapper, *, page_content_columns: Optional[Sequence[str]] = None, metadata_columns: Optional[Sequence[str]] = None)[source]¶ Bases: BaseLoader Loads a query result...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.max_compute.MaxComputeLoader.html
c9b4d4426411-1
environment variable MAX_COMPUTE_ACCESS_ID. secret_access_key – MaxCompute secret access key. Should be passed in directly or set as the environment variable MAX_COMPUTE_SECRET_ACCESS_KEY. lazy_load() → Iterator[Document][source]¶ A lazy loader for document content. load() → List[Document][source]¶ Load data into docum...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.max_compute.MaxComputeLoader.html
518ba22ae42a-0
langchain.document_loaders.parsers.txt.TextParser¶ class langchain.document_loaders.parsers.txt.TextParser[source]¶ Bases: BaseBlobParser Parser for text blobs. Methods __init__() lazy_parse(blob) Lazily parse the blob. parse(blob) Eagerly parse the blob into a document or documents. lazy_parse(blob: Blob) → Iterator[D...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.parsers.txt.TextParser.html
e065e5528830-0
langchain.document_loaders.s3_file.S3FileLoader¶ class langchain.document_loaders.s3_file.S3FileLoader(bucket: str, key: str)[source]¶ Bases: BaseLoader Loading logic for loading documents from s3. Initialize with bucket and key name. Methods __init__(bucket, key) Initialize with bucket and key name. lazy_load() A lazy...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.s3_file.S3FileLoader.html
b123c18c6987-0
langchain.document_loaders.airbyte_json.AirbyteJSONLoader¶ class langchain.document_loaders.airbyte_json.AirbyteJSONLoader(file_path: str)[source]¶ Bases: BaseLoader Loader that loads local airbyte json files. Initialize with file path. This should start with ‘/tmp/airbyte_local/’. Methods __init__(file_path) Initializ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.airbyte_json.AirbyteJSONLoader.html
a4c2530e2b27-0
langchain.document_loaders.pdf.OnlinePDFLoader¶ class langchain.document_loaders.pdf.OnlinePDFLoader(file_path: str)[source]¶ Bases: BasePDFLoader Loader that loads online PDFs. Initialize with file path. Methods __init__(file_path) Initialize with file path. lazy_load() A lazy loader for document content. load() Load ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.pdf.OnlinePDFLoader.html
3fd38f735c18-0
langchain.document_loaders.pdf.MathpixPDFLoader¶ class langchain.document_loaders.pdf.MathpixPDFLoader(file_path: str, processed_file_format: str = 'mmd', max_wait_time_seconds: int = 500, should_clean_pdf: bool = False, **kwargs: Any)[source]¶ Bases: BasePDFLoader Initialize with file path. Methods __init__(file_path[...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.pdf.MathpixPDFLoader.html
e5543afe41bf-0
langchain.document_loaders.unstructured.UnstructuredBaseLoader¶ class langchain.document_loaders.unstructured.UnstructuredBaseLoader(mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: BaseLoader, ABC Loader that uses unstructured to load files. Initialize with file path. Methods __init__([mode]) Initiali...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.unstructured.UnstructuredBaseLoader.html
3020f93ad120-0
langchain.document_loaders.unstructured.UnstructuredFileIOLoader¶ class langchain.document_loaders.unstructured.UnstructuredFileIOLoader(file: Union[IO, Sequence[IO]], mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredBaseLoader Loader that uses unstructured to load file IO objects. Initiali...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.unstructured.UnstructuredFileIOLoader.html
0b3bb3f363d8-0
langchain.document_loaders.odt.UnstructuredODTLoader¶ class langchain.document_loaders.odt.UnstructuredODTLoader(file_path: str, mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load open office ODT files. Initialize with file path. Methods __init...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.odt.UnstructuredODTLoader.html
0a56df0d4639-0
langchain.document_loaders.obsidian.ObsidianLoader¶ class langchain.document_loaders.obsidian.ObsidianLoader(path: str, encoding: str = 'UTF-8', collect_metadata: bool = True)[source]¶ Bases: BaseLoader Loader that loads Obsidian files from disk. Initialize with path. Methods __init__(path[, encoding, collect_metadata]...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.obsidian.ObsidianLoader.html
bd556f256222-0
langchain.document_loaders.gutenberg.GutenbergLoader¶ class langchain.document_loaders.gutenberg.GutenbergLoader(file_path: str)[source]¶ Bases: BaseLoader Loader that uses urllib to load .txt web files. Initialize with file path. Methods __init__(file_path) Initialize with file path. lazy_load() A lazy loader for docu...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.gutenberg.GutenbergLoader.html
2f2df8488214-0
langchain.document_loaders.gcs_file.GCSFileLoader¶ class langchain.document_loaders.gcs_file.GCSFileLoader(project_name: str, bucket: str, blob: str)[source]¶ Bases: BaseLoader Loading logic for loading documents from GCS. Initialize with bucket and key name. Methods __init__(project_name, bucket, blob) Initialize with...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.gcs_file.GCSFileLoader.html
d7dfbf55ac3c-0
langchain.document_loaders.powerpoint.UnstructuredPowerPointLoader¶ class langchain.document_loaders.powerpoint.UnstructuredPowerPointLoader(file_path: Union[str, List[str]], mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load powerpoint files. ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.powerpoint.UnstructuredPowerPointLoader.html
0063810a880b-0
langchain.document_loaders.web_base.WebBaseLoader¶ class langchain.document_loaders.web_base.WebBaseLoader(web_path: Union[str, List[str]], header_template: Optional[dict] = None, verify: Optional[bool] = True, proxies: Optional[dict] = None)[source]¶ Bases: BaseLoader Loader that uses urllib and beautiful soup to load...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.web_base.WebBaseLoader.html
0063810a880b-1
Load text from the url(s) in web_path. load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]¶ Load documents and split into chunks. scrape(parser: Optional[str] = None) → Any[source]¶ Scrape data from webpage and return it in BeautifulSoup format. scrape_all(urls: List[str], parser: Optional[str...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.web_base.WebBaseLoader.html
83858bc1b7bd-0
langchain.document_loaders.telegram.text_to_docs¶ langchain.document_loaders.telegram.text_to_docs(text: Union[str, List[str]]) → List[Document][source]¶ Converts a string or list of strings to a list of Documents with metadata.
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.telegram.text_to_docs.html
b6f22623f5f5-0
langchain.document_loaders.figma.FigmaFileLoader¶ class langchain.document_loaders.figma.FigmaFileLoader(access_token: str, ids: str, key: str)[source]¶ Bases: BaseLoader Loader that loads Figma file json. Initialize with access token, ids, and key. Methods __init__(access_token, ids, key) Initialize with access token,...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.figma.FigmaFileLoader.html
5d9cced20e32-0
langchain.document_loaders.onedrive_file.OneDriveFileLoader¶ class langchain.document_loaders.onedrive_file.OneDriveFileLoader(*, file: File)[source]¶ Bases: BaseLoader, BaseModel Create a new model by parsing and validating input data from keyword arguments. Raises ValidationError if the input data cannot be parsed to...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.onedrive_file.OneDriveFileLoader.html
b389f787ba92-0
langchain.document_loaders.pdf.PyPDFLoader¶ class langchain.document_loaders.pdf.PyPDFLoader(file_path: str, password: Optional[Union[str, bytes]] = None)[source]¶ Bases: BasePDFLoader Loads a PDF with pypdf and chunks at character level. Loader also stores page numbers in metadatas. Initialize with file path. Methods ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.pdf.PyPDFLoader.html
80a495e3f554-0
langchain.document_loaders.unstructured.get_elements_from_api¶ langchain.document_loaders.unstructured.get_elements_from_api(file_path: Optional[Union[str, List[str]]] = None, file: Optional[Union[IO, Sequence[IO]]] = None, api_url: str = 'https://api.unstructured.io/general/v0/general', api_key: str = '', **unstructur...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.unstructured.get_elements_from_api.html
62adcaa6b53a-0
langchain.document_loaders.gitbook.GitbookLoader¶ class langchain.document_loaders.gitbook.GitbookLoader(web_page: str, load_all_paths: bool = False, base_url: Optional[str] = None, content_selector: str = 'main')[source]¶ Bases: WebBaseLoader Load GitBook data. load from either a single page, or load all (relative) pa...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.gitbook.GitbookLoader.html
62adcaa6b53a-1
kwargs for requests requests_per_second Max number of concurrent requests to make. web_path aload() → List[Document]¶ Load text from the urls in web_path async into Documents. async fetch_all(urls: List[str]) → Any¶ Fetch all urls concurrently with rate limiting. lazy_load() → Iterator[Document]¶ Lazy load text from th...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.gitbook.GitbookLoader.html
46e61152b13b-0
langchain.document_loaders.python.PythonLoader¶ class langchain.document_loaders.python.PythonLoader(file_path: str)[source]¶ Bases: TextLoader Load Python files, respecting any non-default encoding if specified. Initialize with file path. Methods __init__(file_path) Initialize with file path. lazy_load() A lazy loader...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.python.PythonLoader.html
31382f5ef3b0-0
langchain.document_loaders.parsers.language.python.PythonSegmenter¶ class langchain.document_loaders.parsers.language.python.PythonSegmenter(code: str)[source]¶ Bases: CodeSegmenter Methods __init__(code) extract_functions_classes() is_valid() simplify_code() extract_functions_classes() → List[str][source]¶ is_valid() ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.parsers.language.python.PythonSegmenter.html
29e7cfac1d25-0
langchain.document_loaders.toml.TomlLoader¶ class langchain.document_loaders.toml.TomlLoader(source: Union[str, Path])[source]¶ Bases: BaseLoader A TOML document loader that inherits from the BaseLoader class. This class can be initialized with either a single source file or a source directory containing TOML files. In...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.toml.TomlLoader.html
73132c3a13be-0
langchain.document_loaders.email.UnstructuredEmailLoader¶ class langchain.document_loaders.email.UnstructuredEmailLoader(file_path: Union[str, List[str]], mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load email files. Initialize with file path...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.email.UnstructuredEmailLoader.html
1ad69d299eb4-0
langchain.document_loaders.bilibili.BiliBiliLoader¶ class langchain.document_loaders.bilibili.BiliBiliLoader(video_urls: List[str])[source]¶ Bases: BaseLoader Loader that loads bilibili transcripts. Initialize with bilibili url. Methods __init__(video_urls) Initialize with bilibili url. lazy_load() A lazy loader for do...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.bilibili.BiliBiliLoader.html
eb7b847ef1fe-0
langchain.document_loaders.json_loader.JSONLoader¶ class langchain.document_loaders.json_loader.JSONLoader(file_path: Union[str, Path], jq_schema: str, content_key: Optional[str] = None, metadata_func: Optional[Callable[[Dict, Dict], Dict]] = None, text_content: bool = True)[source]¶ Bases: BaseLoader Loads a JSON file...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.json_loader.JSONLoader.html
eb7b847ef1fe-1
lazy_load() → Iterator[Document]¶ A lazy loader for document content. load() → List[Document][source]¶ Load and return documents from the JSON file. load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]¶ Load documents and split into chunks.
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.json_loader.JSONLoader.html
a45949880335-0
langchain.document_loaders.xml.UnstructuredXMLLoader¶ class langchain.document_loaders.xml.UnstructuredXMLLoader(file_path: str, mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load XML files. Initialize with file path. Methods __init__(file_path...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.xml.UnstructuredXMLLoader.html
c0d6c2f7ef00-0
langchain.document_loaders.joplin.JoplinLoader¶ class langchain.document_loaders.joplin.JoplinLoader(access_token: Optional[str] = None, port: int = 41184, host: str = 'localhost')[source]¶ Bases: BaseLoader Loader that fetches notes from Joplin. In order to use this loader, you need to have Joplin running with the Web...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.joplin.JoplinLoader.html
47c6c50d4275-0
langchain.document_loaders.image_captions.ImageCaptionLoader¶ class langchain.document_loaders.image_captions.ImageCaptionLoader(path_images: Union[str, List[str]], blip_processor: str = 'Salesforce/blip-image-captioning-base', blip_model: str = 'Salesforce/blip-image-captioning-base')[source]¶ Bases: BaseLoader Loader...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.image_captions.ImageCaptionLoader.html
214f40d95a85-0
langchain.document_loaders.snowflake_loader.SnowflakeLoader¶ class langchain.document_loaders.snowflake_loader.SnowflakeLoader(query: str, user: str, password: str, account: str, warehouse: str, role: str, database: str, schema: str, parameters: Optional[Dict[str, Any]] = None, page_content_columns: Optional[List[str]]...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.snowflake_loader.SnowflakeLoader.html
b89feecb5cd5-0
langchain.document_loaders.mhtml.MHTMLLoader¶ class langchain.document_loaders.mhtml.MHTMLLoader(file_path: str, open_encoding: Optional[str] = None, bs_kwargs: Optional[dict] = None, get_text_separator: str = '')[source]¶ Bases: BaseLoader Loader that uses beautiful soup to parse HTML files. Initialise with path, and ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.mhtml.MHTMLLoader.html
e5ab26f506f9-0
langchain.document_loaders.hugging_face_dataset.HuggingFaceDatasetLoader¶ class langchain.document_loaders.hugging_face_dataset.HuggingFaceDatasetLoader(path: str, page_content_column: str = 'text', name: Optional[str] = None, data_dir: Optional[str] = None, data_files: Optional[Union[str, Sequence[str], Mapping[str, U...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.hugging_face_dataset.HuggingFaceDatasetLoader.html
e5ab26f506f9-1
load() → List[Document][source]¶ Load documents. load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]¶ Load documents and split into chunks.
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.hugging_face_dataset.HuggingFaceDatasetLoader.html
2f066a1e1ed7-0
langchain.document_loaders.embaas.EmbaasBlobLoader¶ class langchain.document_loaders.embaas.EmbaasBlobLoader(*, embaas_api_key: Optional[str] = None, api_url: str = 'https://api.embaas.io/v1/document/extract-text/bytes/', params: EmbaasDocumentExtractionParameters = {})[source]¶ Bases: BaseEmbaasLoader, BaseBlobParser ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.embaas.EmbaasBlobLoader.html
2f066a1e1ed7-1
param embaas_api_key: Optional[str] = None¶ param params: langchain.document_loaders.embaas.EmbaasDocumentExtractionParameters = {}¶ Additional parameters to pass to the embaas document extraction API. lazy_parse(blob: Blob) → Iterator[Document][source]¶ Lazy parsing interface. Subclasses are required to implement this...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.embaas.EmbaasBlobLoader.html
3b76b8f34231-0
langchain.document_loaders.parsers.grobid.GrobidParser¶ class langchain.document_loaders.parsers.grobid.GrobidParser(segment_sentences: bool, grobid_server: str = 'http://localhost:8070/api/processFulltextDocument')[source]¶ Bases: BaseBlobParser Loader that uses Grobid to load article PDF files. Methods __init__(segme...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.parsers.grobid.GrobidParser.html
ce557662964e-0
langchain.document_loaders.bibtex.BibtexLoader¶ class langchain.document_loaders.bibtex.BibtexLoader(file_path: str, *, parser: Optional[BibtexparserWrapper] = None, max_docs: Optional[int] = None, max_content_chars: Optional[int] = 4000, load_extra_metadata: bool = False, file_pattern: str = '[^:]+\\.pdf')[source]¶ Ba...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.bibtex.BibtexLoader.html
ce557662964e-1
See https://bibtexparser.readthedocs.io/en/master/ Parameters file_path – the path to the bibtex file Returns a list of documents with the document.page_content in text format load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]¶ Load documents and split into chunks.
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.bibtex.BibtexLoader.html
9f8112efacc3-0
langchain.document_loaders.image.UnstructuredImageLoader¶ class langchain.document_loaders.image.UnstructuredImageLoader(file_path: Union[str, List[str]], mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load image files, such as PNGs and JPGs. In...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.image.UnstructuredImageLoader.html
1b9c169dda82-0
langchain.document_loaders.parsers.grobid.ServerUnavailableException¶ class langchain.document_loaders.parsers.grobid.ServerUnavailableException[source]¶ Bases: Exception add_note()¶ Exception.add_note(note) – add a note to the exception with_traceback()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.parsers.grobid.ServerUnavailableException.html
3b1f48431dd3-0
langchain.document_loaders.rst.UnstructuredRSTLoader¶ class langchain.document_loaders.rst.UnstructuredRSTLoader(file_path: str, mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load RST files. Initialize with file path. Methods __init__(file_path...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.rst.UnstructuredRSTLoader.html
b5688629636e-0
langchain.document_loaders.spreedly.SpreedlyLoader¶ class langchain.document_loaders.spreedly.SpreedlyLoader(access_token: str, resource: str)[source]¶ Bases: BaseLoader Loader that fetches data from Spreedly API. Methods __init__(access_token, resource) lazy_load() A lazy loader for document content. load() Load data ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.spreedly.SpreedlyLoader.html
7cc45dda5450-0
langchain.document_loaders.html_bs.BSHTMLLoader¶ class langchain.document_loaders.html_bs.BSHTMLLoader(file_path: str, open_encoding: Optional[str] = None, bs_kwargs: Optional[dict] = None, get_text_separator: str = '')[source]¶ Bases: BaseLoader Loader that uses beautiful soup to parse HTML files. Initialise with path...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.html_bs.BSHTMLLoader.html
7506a25da504-0
langchain.document_loaders.text.TextLoader¶ class langchain.document_loaders.text.TextLoader(file_path: str, encoding: Optional[str] = None, autodetect_encoding: bool = False)[source]¶ Bases: BaseLoader Load text files. Parameters file_path – Path to the file to load. encoding – File encoding to use. If None, the file ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.text.TextLoader.html
309060c6ddac-0
langchain.document_loaders.base.BaseBlobParser¶ class langchain.document_loaders.base.BaseBlobParser[source]¶ Bases: ABC Abstract interface for blob parsers. A blob parser is provides a way to parse raw data stored in a blob into one or more documents. The parser can be composed with blob loaders, making it easy to re-...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.base.BaseBlobParser.html
2a0ef7f16ee0-0
langchain.document_loaders.slack_directory.SlackDirectoryLoader¶ class langchain.document_loaders.slack_directory.SlackDirectoryLoader(zip_path: str, workspace_url: Optional[str] = None)[source]¶ Bases: BaseLoader Loader for loading documents from a Slack directory dump. Initialize the SlackDirectoryLoader. Parameters ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.slack_directory.SlackDirectoryLoader.html
735b07bd408f-0
langchain.document_loaders.iugu.IuguLoader¶ class langchain.document_loaders.iugu.IuguLoader(resource: str, api_token: Optional[str] = None)[source]¶ Bases: BaseLoader Loader that fetches data from IUGU. Methods __init__(resource[, api_token]) lazy_load() A lazy loader for document content. load() Load data into docume...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.iugu.IuguLoader.html
b99eee13531d-0
langchain.document_loaders.excel.UnstructuredExcelLoader¶ class langchain.document_loaders.excel.UnstructuredExcelLoader(file_path: str, mode: str = 'single', **unstructured_kwargs: Any)[source]¶ Bases: UnstructuredFileLoader Loader that uses unstructured to load Microsoft Excel files. Initialize with file path. Method...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.excel.UnstructuredExcelLoader.html
c1759145760e-0
langchain.document_loaders.pdf.PDFMinerLoader¶ class langchain.document_loaders.pdf.PDFMinerLoader(file_path: str)[source]¶ Bases: BasePDFLoader Loader that uses PDFMiner to load PDF files. Initialize with file path. Methods __init__(file_path) Initialize with file path. lazy_load() Lazily lod documents. load() Eagerly...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.pdf.PDFMinerLoader.html
44865a745ff2-0
langchain.document_loaders.parsers.pdf.PDFMinerParser¶ class langchain.document_loaders.parsers.pdf.PDFMinerParser[source]¶ Bases: BaseBlobParser Parse PDFs with PDFMiner. Methods __init__() lazy_parse(blob) Lazily parse the blob. parse(blob) Eagerly parse the blob into a document or documents. lazy_parse(blob: Blob) →...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.parsers.pdf.PDFMinerParser.html
f349fdf5d40f-0
langchain.document_loaders.pdf.PyMuPDFLoader¶ class langchain.document_loaders.pdf.PyMuPDFLoader(file_path: str)[source]¶ Bases: BasePDFLoader Loader that uses PyMuPDF to load PDF files. Initialize with file path. Methods __init__(file_path) Initialize with file path. lazy_load() A lazy loader for document content. loa...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.pdf.PyMuPDFLoader.html
4f246b2ccb73-0
langchain.document_loaders.telegram.concatenate_rows¶ langchain.document_loaders.telegram.concatenate_rows(row: dict) → str[source]¶ Combine message information in a readable format ready to be used.
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.telegram.concatenate_rows.html
ee1f714aca62-0
langchain.document_loaders.pdf.PyPDFDirectoryLoader¶ class langchain.document_loaders.pdf.PyPDFDirectoryLoader(path: str, glob: str = '**/[!.]*.pdf', silent_errors: bool = False, load_hidden: bool = False, recursive: bool = False)[source]¶ Bases: BaseLoader Loads a directory with PDF files with pypdf and chunks at char...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.pdf.PyPDFDirectoryLoader.html
5e34a21cb2cb-0
langchain.document_loaders.arxiv.ArxivLoader¶ class langchain.document_loaders.arxiv.ArxivLoader(query: str, load_max_docs: Optional[int] = 100, load_all_available_meta: Optional[bool] = False)[source]¶ Bases: BaseLoader Loads a query result from arxiv.org into a list of Documents. Each document represents one Document...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.arxiv.ArxivLoader.html
ebd88ce0db1c-0
langchain.document_loaders.generic.GenericLoader¶ class langchain.document_loaders.generic.GenericLoader(blob_loader: BlobLoader, blob_parser: BaseBlobParser)[source]¶ Bases: BaseLoader A generic document loader. A generic document loader that allows combining an arbitrary blob loader with a blob parser. Examples from ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.generic.GenericLoader.html
ebd88ce0db1c-1
Methods __init__(blob_loader, blob_parser) A generic document loader. from_filesystem(path, *[, glob, suffixes, ...]) Create a generic document loader using a filesystem blob loader. lazy_load() Load documents lazily. load() Load all documents. load_and_split([text_splitter]) Load all documents and split them into sent...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.generic.GenericLoader.html
ee9378716492-0
langchain.document_loaders.mediawikidump.MWDumpLoader¶ class langchain.document_loaders.mediawikidump.MWDumpLoader(file_path: str, encoding: Optional[str] = 'utf8')[source]¶ Bases: BaseLoader Load MediaWiki dump from XML file .. rubric:: Example from langchain.document_loaders import MWDumpLoader loader = MWDumpLoader(...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.mediawikidump.MWDumpLoader.html
d56cef2cb5c5-0
langchain.document_loaders.stripe.StripeLoader¶ class langchain.document_loaders.stripe.StripeLoader(resource: str, access_token: Optional[str] = None)[source]¶ Bases: BaseLoader Loader that fetches data from Stripe. Methods __init__(resource[, access_token]) lazy_load() A lazy loader for document content. load() Load ...
https://api.python.langchain.com/en/latest/document_loaders/langchain.document_loaders.stripe.StripeLoader.html
69fb39233d26-0
langchain.prompts.base.StringPromptTemplate¶ class langchain.prompts.base.StringPromptTemplate(*, input_variables: List[str], output_parser: Optional[BaseOutputParser] = None, partial_variables: Mapping[str, Union[str, Callable[[], str]]] = None)[source]¶ Bases: BasePromptTemplate, ABC String prompt should expose the f...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.base.StringPromptTemplate.html
69fb39233d26-1
validator validate_variable_names  »  all fields¶ Validate variable names do not include restricted names. property lc_attributes: Dict¶ Return a list of attribute names that should be included in the serialized kwargs. These attributes must be accepted by the constructor. property lc_namespace: List[str]¶ Return the n...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.base.StringPromptTemplate.html
df9445d5adab-0
langchain.prompts.loading.load_prompt_from_config¶ langchain.prompts.loading.load_prompt_from_config(config: dict) → BasePromptTemplate[source]¶ Load prompt from Config Dict.
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.loading.load_prompt_from_config.html
e037cb7d0796-0
langchain.prompts.chat.BaseStringMessagePromptTemplate¶ class langchain.prompts.chat.BaseStringMessagePromptTemplate(*, prompt: StringPromptTemplate, additional_kwargs: dict = None)[source]¶ Bases: BaseMessagePromptTemplate, ABC Create a new model by parsing and validating input data from keyword arguments. Raises Vali...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.chat.BaseStringMessagePromptTemplate.html
e037cb7d0796-1
Return whether or not the class is serializable. model Config¶ Bases: object extra = 'ignore'¶
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.chat.BaseStringMessagePromptTemplate.html
4cb19ff568cd-0
langchain.prompts.prompt.PromptTemplate¶ class langchain.prompts.prompt.PromptTemplate(*, input_variables: List[str], output_parser: Optional[BaseOutputParser] = None, partial_variables: Mapping[str, Union[str, Callable[[], str]]] = None, template: str, template_format: str = 'f-string', validate_template: bool = True)...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.prompt.PromptTemplate.html
4cb19ff568cd-1
format_prompt(**kwargs: Any) → PromptValue¶ Create Chat Messages. classmethod from_examples(examples: List[str], suffix: str, input_variables: List[str], example_separator: str = '\n\n', prefix: str = '', **kwargs: Any) → PromptTemplate[source]¶ Take examples in list format with prefix and suffix to create a prompt. In...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.prompt.PromptTemplate.html
4cb19ff568cd-2
validator template_is_valid  »  all fields[source]¶ Check that template and input variables are consistent. to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶ to_json_not_implemented() → SerializedNotImplemented¶ validator validate_variable_names  »  all fields¶ Validate variable names do not include r...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.prompt.PromptTemplate.html
ec9a1584873c-0
langchain.prompts.example_selector.base.BaseExampleSelector¶ class langchain.prompts.example_selector.base.BaseExampleSelector[source]¶ Bases: ABC Interface for selecting examples to include in prompts. Methods __init__() add_example(example) Add new example to store for a key. select_examples(input_variables) Select w...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.example_selector.base.BaseExampleSelector.html
8617e4e0de2f-0
langchain.prompts.chat.ChatPromptTemplate¶ class langchain.prompts.chat.ChatPromptTemplate(*, input_variables: List[str], output_parser: Optional[BaseOutputParser] = None, partial_variables: Mapping[str, Union[str, Callable[[], str]]] = None, messages: List[Union[BaseMessagePromptTemplate, BaseMessage]])[source]¶ Bases...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.chat.ChatPromptTemplate.html
8617e4e0de2f-1
classmethod from_template(template: str, **kwargs: Any) → ChatPromptTemplate[source]¶ partial(**kwargs: Union[str, Callable[[], str]]) → BasePromptTemplate[source]¶ Return a partial of the prompt template. save(file_path: Union[Path, str]) → None[source]¶ Save the prompt. Parameters file_path – Path to directory to sav...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.chat.ChatPromptTemplate.html
657696fcf5f4-0
langchain.prompts.chat.AIMessagePromptTemplate¶ class langchain.prompts.chat.AIMessagePromptTemplate(*, prompt: StringPromptTemplate, additional_kwargs: dict = None)[source]¶ Bases: BaseStringMessagePromptTemplate Create a new model by parsing and validating input data from keyword arguments. Raises ValidationError if ...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.chat.AIMessagePromptTemplate.html
b08008f09981-0
langchain.prompts.example_selector.semantic_similarity.sorted_values¶ langchain.prompts.example_selector.semantic_similarity.sorted_values(values: Dict[str, str]) → List[Any][source]¶ Return a list of values in dict sorted by key.
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.example_selector.semantic_similarity.sorted_values.html
52487d9fff54-0
langchain.prompts.base.check_valid_template¶ langchain.prompts.base.check_valid_template(template: str, template_format: str, input_variables: List[str]) → None[source]¶ Check that template string is valid.
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.base.check_valid_template.html
24261e6f25d5-0
langchain.prompts.few_shot_with_templates.FewShotPromptWithTemplates¶ class langchain.prompts.few_shot_with_templates.FewShotPromptWithTemplates(*, input_variables: List[str], output_parser: Optional[BaseOutputParser] = None, partial_variables: Mapping[str, Union[str, Callable[[], str]]] = None, examples: Optional[List...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.few_shot_with_templates.FewShotPromptWithTemplates.html
24261e6f25d5-1
param prefix: Optional[langchain.prompts.base.StringPromptTemplate] = None¶ A PromptTemplate to put before the examples. param suffix: langchain.prompts.base.StringPromptTemplate [Required]¶ A PromptTemplate to put after the examples. param template_format: str = 'f-string'¶ The format of the prompt template. Options a...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.few_shot_with_templates.FewShotPromptWithTemplates.html
24261e6f25d5-2
property lc_attributes: Dict¶ Return a list of attribute names that should be included in the serialized kwargs. These attributes must be accepted by the constructor. property lc_namespace: List[str]¶ Return the namespace of the langchain object. eg. [“langchain”, “llms”, “openai”] property lc_secrets: Dict[str, str]¶ ...
https://api.python.langchain.com/en/latest/prompts/langchain.prompts.few_shot_with_templates.FewShotPromptWithTemplates.html