langchain_community.document_loaders.apify_dataset.ApifyDatasetLoader

class langchain_community.document_loaders.apify_dataset.ApifyDatasetLoader

Bases: BaseLoader, BaseModel

Load datasets from Apify web scraping, crawling, and data extraction platform.

For details, see https://docs.apify.com/platform/integrations/langchain

Example

from langchain_community.document_loaders import ApifyDatasetLoader
from langchain_core.documents 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()

Initialize the loader with an Apify dataset ID and a mapping function.

Parameters

• dataset_id (str) – The ID of the dataset on the Apify platform.

• dataset_mapping_function (Callable) – A function that takes a single dictionary (an Apify dataset item) and converts it to an instance of the Document class.

param apify_client: Any = None

An instance of the ApifyClient class from the apify-client Python package.

param dataset_id: str [Required]

The ID of the dataset on the Apify platform.

param dataset_mapping_function: Callable[[Dict], Document] [Required]

A custom function that takes a single dictionary (an Apify dataset item) and converts it to an instance of the Document class.

async alazy_load() → AsyncIterator[Document]

A lazy loader for Documents.

Return type

AsyncIterator[Document]

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Parameters

• _fields_set (Optional[SetStr]) –

• values (Any) –

Return type

Model

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

• include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model

• exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to exclude from new model, as with values this takes precedence over include

• update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

• deep (bool) – set to True to make a deep copy of the model

• self (Model) –

Returns

new model instance

Return type

Model

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters

• include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

• exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

• by_alias (bool) –

• skip_defaults (Optional[bool]) –

• exclude_unset (bool) –

• exclude_defaults (bool) –

• exclude_none (bool) –

Return type

DictStrAny

classmethod from_orm(obj: Any) → Model

Parameters

obj (Any) –

Return type

Model

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Parameters

• include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

• exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

• by_alias (bool) –

• skip_defaults (Optional[bool]) –

• exclude_unset (bool) –

• exclude_defaults (bool) –

• exclude_none (bool) –

• encoder (Optional[Callable[[Any], Any]]) –

• models_as_dict (bool) –

• dumps_kwargs (Any) –

Return type

unicode

lazy_load() → Iterator[Document]

A lazy loader for Documents.

Return type

Iterator[Document]

load() → List[Document]

Load documents.

Return type

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]

Load Documents and split into chunks. Chunks are returned as Documents.

Do not override this method. It should be considered to be deprecated!

Parameters

text_splitter (Optional[TextSplitter]) – TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.

Returns

List of Documents.

Return type

List[Document]

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model

Parameters

• path (Union[str, Path]) –

• content_type (unicode) –

• encoding (unicode) –

• proto (Protocol) –

• allow_pickle (bool) –

Return type

Model

classmethod parse_obj(obj: Any) → Model

Parameters

obj (Any) –

Return type

Model

classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model

Parameters

• b (Union[str, bytes]) –

• content_type (unicode) –

• encoding (unicode) –

• proto (Protocol) –

• allow_pickle (bool) –

Return type

Model

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny

Parameters

• by_alias (bool) –

• ref_template (unicode) –

Return type

DictStrAny

classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode

Parameters

• by_alias (bool) –

• ref_template (unicode) –

• dumps_kwargs (Any) –

Return type

unicode

classmethod update_forward_refs(**localns: Any) → None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Parameters

localns (Any) –

Return type

None

classmethod validate(value: Any) → Model

Parameters

value (Any) –

Return type

Model

Examples using ApifyDatasetLoader

• Apify

• Apify Dataset