Class: IngestionPipeline
Constructors
new IngestionPipeline()
new IngestionPipeline(
init
?):IngestionPipeline
Parameters
• init?: Partial
<IngestionPipeline
> & ClientParams
Returns
Source
packages/core/src/ingestion/IngestionPipeline.ts:87
Properties
_docStoreStrategy?
private
optional
_docStoreStrategy:TransformComponent
Source
packages/core/src/ingestion/IngestionPipeline.ts:85
cache?
optional
cache:IngestionCache
Source
packages/core/src/ingestion/IngestionPipeline.ts:78
client?
optional
client:PlatformApiClient
Source
packages/core/src/ingestion/IngestionPipeline.ts:80
clientParams?
optional
clientParams:ClientParams
Source
packages/core/src/ingestion/IngestionPipeline.ts:81
disableCache
disableCache:
boolean
=false
Source
packages/core/src/ingestion/IngestionPipeline.ts:79
docStore?
optional
docStore:BaseDocumentStore
Source
packages/core/src/ingestion/IngestionPipeline.ts:76
docStoreStrategy
docStoreStrategy:
DocStoreStrategy
=DocStoreStrategy.UPSERTS
Source
packages/core/src/ingestion/IngestionPipeline.ts:77
documents?
Source
packages/core/src/ingestion/IngestionPipeline.ts:72
name
name:
string
=DEFAULT_PIPELINE_NAME
Source
packages/core/src/ingestion/IngestionPipeline.ts:83
projectName
projectName:
string
=DEFAULT_PROJECT_NAME
Source
packages/core/src/ingestion/IngestionPipeline.ts:82
reader?
optional
reader:BaseReader
Source
packages/core/src/ingestion/IngestionPipeline.ts:73
transformations
transformations:
TransformComponent
[] =[]
Source
packages/core/src/ingestion/IngestionPipeline.ts:71
vectorStore?
optional
vectorStore:VectorStore
Source
packages/core/src/ingestion/IngestionPipeline.ts:74
vectorStores?
optional
vectorStores:VectorStoreByType
Source
packages/core/src/ingestion/IngestionPipeline.ts:75
Methods
getClient()
private
getClient():Promise
<PlatformApiClient
>
Returns
Promise
<PlatformApiClient
>
Source
packages/core/src/ingestion/IngestionPipeline.ts:146
prepareInput()
prepareInput(
documents
?,nodes
?):Promise
<BaseNode
<Metadata
>[]>
Parameters
• documents?: Document
<Metadata
>[]
• nodes?: BaseNode
<Metadata
>[]
Returns
Promise
<BaseNode
<Metadata
>[]>
Source
packages/core/src/ingestion/IngestionPipeline.ts:106
register()
register(
params
):Promise
<string
>
Parameters
• params
• params.documents?: Document
<Metadata
>[]
• params.nodes?: BaseNode
<Metadata
>[]
• params.verbose?: boolean
Returns
Promise
<string
>
Source
packages/core/src/ingestion/IngestionPipeline.ts:153
run()
run(
args
,transformOptions
?):Promise
<BaseNode
<Metadata
>[]>
Parameters
• args: IngestionRunArgs
& TransformRunArgs
= {}
• transformOptions?: any
Returns
Promise
<BaseNode
<Metadata
>[]>