Class ApifyDatasetLoader

A class that extends the BaseDocumentLoader and implements the DocumentLoader interface. It represents a document loader that loads documents from an Apify dataset.

Hierarchy

BaseDocumentLoader
- ApifyDatasetLoader

Implements

DocumentLoader

Index

Constructors

constructor

new ApifyDatasetLoader(datasetId, config): ApifyDatasetLoader
Parameters
- datasetId: string
- config: {
  datasetMappingFunction: ApifyDatasetMappingFunction;
  clientOptions?: ApifyClientOptions;
  }
  - datasetMappingFunction: ApifyDatasetMappingFunction
  - Optional clientOptions?: ApifyClientOptions
Returns ApifyDatasetLoader
Overrides BaseDocumentLoader.constructor
- Defined in langchain/src/document_loaders/web/apify_dataset.ts:37

Properties

`Protected` apifyClient

apifyClient: ApifyClient

`Protected` datasetId

datasetId: string

`Protected` datasetMappingFunction

datasetMappingFunction: ((item) => Document<Record<string, any>>)

Type declaration

- (item): Document<Record<string, any>>
- Parameters
  - item: Record<string | number, unknown>
  Returns Document<Record<string, any>>

Methods

load

load(): Promise<Document<Record<string, any>>[]>
Retrieves the dataset items from the Apify platform and applies the datasetMappingFunction to each item to create an array of Document instances.

Returns Promise<Document<Record<string, any>>[]>
An array of Document instances.
Implementation of DocumentLoader.load

Overrides BaseDocumentLoader.load
- Defined in langchain/src/document_loaders/web/apify_dataset.ts:66

loadAndSplit

loadAndSplit(splitter?): Promise<Document<Record<string, any>>[]>
Loads the documents and splits them using a specified text splitter.
Parameters
- splitter: TextSplitter = ...
Returns Promise<Document<Record<string, any>>[]>
A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.
Implementation of DocumentLoader.loadAndSplit

Inherited from BaseDocumentLoader.loadAndSplit
- Defined in langchain/src/document_loaders/base.ts:32

`Static` fromActorCall

fromActorCall(actorId, input, config): Promise<ApifyDatasetLoader>
Create an ApifyDatasetLoader by calling an Actor on the Apify platform and waiting for its results to be ready.
Parameters
- actorId: string
  
  The ID or name of the Actor on the Apify platform.
- input: Record<string | number, unknown>
  
  The input object of the Actor that you're trying to run.
- config: {
      datasetMappingFunction: ApifyDatasetMappingFunction;
      callOptions?: ActorCallOptions;
      clientOptions?: ApifyClientOptions;
  }
  - datasetMappingFunction: ApifyDatasetMappingFunction
  - Optional callOptions?: ActorCallOptions
  - Optional clientOptions?: ApifyClientOptions
Returns Promise<ApifyDatasetLoader>
An instance of ApifyDatasetLoader with the results from the Actor run.
- Defined in langchain/src/document_loaders/web/apify_dataset.ts:81

`Static` fromActorTaskCall

fromActorTaskCall(taskId, input, config): Promise<ApifyDatasetLoader>
Create an ApifyDatasetLoader by calling a saved Actor task on the Apify platform and waiting for its results to be ready.
Parameters
- taskId: string
  
  The ID or name of the task on the Apify platform.
- input: Record<string | number, unknown>
  
  The input object of the task that you're trying to run. Overrides the task's saved input.
- config: {
      datasetMappingFunction: ApifyDatasetMappingFunction;
      callOptions?: TaskCallOptions;
      clientOptions?: ApifyClientOptions;
  }
  - datasetMappingFunction: ApifyDatasetMappingFunction
  - Optional callOptions?: TaskCallOptions
  - Optional clientOptions?: ApifyClientOptions
Returns Promise<ApifyDatasetLoader>
An instance of ApifyDatasetLoader with the results from the task's run.
- Defined in langchain/src/document_loaders/web/apify_dataset.ts:113

Class ApifyDatasetLoader

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

datasetId: string

config: { datasetMappingFunction: ApifyDatasetMappingFunction; clientOptions?: ApifyClientOptions; }

datasetMappingFunction: ApifyDatasetMappingFunction

Optional clientOptions?: ApifyClientOptions

Returns ApifyDatasetLoader

Properties

Protected apifyClient

Protected datasetId

Protected datasetMappingFunction

Type declaration

Parameters

item: Record<string | number, unknown>

Returns Document<Record<string, any>>

Methods

load

Returns Promise<Document<Record<string, any>>[]>

loadAndSplit

Parameters

splitter: TextSplitter = ...

Returns Promise<Document<Record<string, any>>[]>

Static fromActorCall

Parameters

actorId: string

input: Record<string | number, unknown>

config: { datasetMappingFunction: ApifyDatasetMappingFunction; callOptions?: ActorCallOptions; clientOptions?: ApifyClientOptions; }

datasetMappingFunction: ApifyDatasetMappingFunction

Optional callOptions?: ActorCallOptions

Optional clientOptions?: ApifyClientOptions

Returns Promise<ApifyDatasetLoader>

Static fromActorTaskCall

Parameters

taskId: string

input: Record<string | number, unknown>

config: { datasetMappingFunction: ApifyDatasetMappingFunction; callOptions?: TaskCallOptions; clientOptions?: ApifyClientOptions; }

datasetMappingFunction: ApifyDatasetMappingFunction

Optional callOptions?: TaskCallOptions

Optional clientOptions?: ApifyClientOptions

Returns Promise<ApifyDatasetLoader>

Settings

Member Visibility

Theme

On This Page

config: {
datasetMappingFunction: ApifyDatasetMappingFunction;
clientOptions?: ApifyClientOptions;
}

`Optional` clientOptions?: ApifyClientOptions

`Protected` apifyClient

`Protected` datasetId

`Protected` datasetMappingFunction

`Static` fromActorCall

config: {
datasetMappingFunction: ApifyDatasetMappingFunction;
callOptions?: ActorCallOptions;
clientOptions?: ApifyClientOptions;
}

`Optional` callOptions?: ActorCallOptions

`Optional` clientOptions?: ApifyClientOptions

`Static` fromActorTaskCall

config: {
datasetMappingFunction: ApifyDatasetMappingFunction;
callOptions?: TaskCallOptions;
clientOptions?: ApifyClientOptions;
}

`Optional` callOptions?: TaskCallOptions

`Optional` clientOptions?: ApifyClientOptions