Class: IngestionPipeline
Constructors
constructor
• new IngestionPipeline(init?): IngestionPipeline
Parameters
| Name | Type |
|---|---|
init? | Partial<IngestionPipeline> & ClientParams |
Returns
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:77
Properties
_docStoreStrategy
• Private Optional _docStoreStrategy: TransformComponent
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:75
cache
• Optional cache: IngestionCache
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:68
client
• Optional client: PlatformApiClient
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:70
clientParams
• Optional clientParams: ClientParams
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:71
disableCache
• disableCache: boolean = false
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:69
docStore
• Optional docStore: BaseDocumentStore
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:66
docStoreStrategy
• docStoreStrategy: DocStoreStrategy = DocStoreStrategy.UPSERTS
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:67
documents
• Optional documents: Document<Metadata>[]
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:63
name
• name: string = DEFAULT_PIPELINE_NAME
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:73
projectName
• projectName: string = DEFAULT_PROJECT_NAME
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:72
reader
• Optional reader: BaseReader
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:64
transformations
• transformations: TransformComponent[] = []
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:62
vectorStore
• Optional vectorStore: VectorStore
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:65
Methods
getClient
▸ getClient(): Promise<PlatformApiClient>
Returns
Promise<PlatformApiClient>
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:133
prepareInput
▸ prepareInput(documents?, nodes?): Promise<BaseNode<Metadata>[]>
Parameters
| Name | Type |
|---|---|
documents? | Document<Metadata>[] |
nodes? | BaseNode<Metadata>[] |
Returns
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:93
register
▸ register(params): Promise<string>
Parameters
| Name | Type |
|---|---|
params | Object |
params.documents? | Document<Metadata>[] |
params.nodes? | BaseNode<Metadata>[] |
params.verbose? | boolean |
Returns
Promise<string>
Defined in
packages/core/src/ingestion/IngestionPipeline.ts:140
run
▸ run(args?, transformOptions?): Promise<BaseNode<Metadata>[]>
Parameters
| Name | Type |
|---|---|
args | IngestionRunArgs & TransformRunArgs |
transformOptions? | any |