Skip to content

Commit

Permalink
docs: Improve ApifyDatasetLoader docstring (#4)
Browse files Browse the repository at this point in the history
Co-authored-by: Jan Čurn <[email protected]>
  • Loading branch information
jirimoravcik and jancurn authored Jul 17, 2023
1 parent ff3aada commit d1e2a6a
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion langchain/document_loaders/apify_dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,24 @@


class ApifyDatasetLoader(BaseLoader, BaseModel):
"""Loading Documents from Apify datasets."""
"""Loads datasets from Apify-a web scraping, crawling, and data extraction platform.
For details, see https://docs.apify.com/platform/integrations/langchain
Example:
```python
from langchain.document_loaders import ApifyDatasetLoader
from langchain.document_loaders.base import Document
loader = ApifyDatasetLoader(
dataset_id="YOUR-DATASET-ID",
dataset_mapping_function=lambda dataset_item: Document(
page_content=dataset_item["text"], metadata={"source": dataset_item["url"]}
),
)
documents = loader.load()
```
"""

apify_client: Any
"""An instance of the ApifyClient class from the apify-client Python package."""
Expand Down

0 comments on commit d1e2a6a

Please sign in to comment.