langchain_community.document_loaders.apify_dataset.ApifyDatasetLoaderยถ

class langchain_community.document_loaders.apify_dataset.ApifyDatasetLoader[source]ยถ

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][source]ยถ

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ยถ