search

deepset-ai / haystack

AI orchestration framework to build customizable, production-ready LLM applications. Connect components (models, vector DBs, file converters) to pipelines or agents that can interact with your data. With advanced retrieval methods, it's best suited for building RAG, question answering, semantic search or conversational agent chatbots.
https://haystack.deepset.ai
Apache License 2.0
17.72k stars 1.92k forks source link

docs: Run vs Initialization parameters #8272

Closed TuanaCelik closed 2 months ago

TuanaCelik commented 2 months ago

When we first started creating the Haystack 2.0 docs we had a standard for making sure we list the inputs for the component torun() the component as well as the Parameters/Initialization Parameter But I don't think we do this anymore.

It would be super useful if we did this consistently.

Example: DocumentWriter This component expects documents to run, but expects a document_store at initialization. This fact is only shown in the code snippet.

aantti commented 2 months ago

I second this. Was stumped for a while trying to figure it out.

Boben19 commented 2 months ago

Yess

dfokina commented 2 months ago

I introduced the changes with the new component table format. The changes are live from v.2.6 onward.

Example: https://docs.haystack.deepset.ai/v2.6-unstable/docs/documentwriter