Vladimir Blagojevic
eb7974e78f
Add TransformersZeroShotTextRouter to docs ( #7433 )
2024-03-27 13:20:34 +01:00
Stefano Fiorucci
dbfd351da7
feat: introduce SparseEmbedding
( #7382 )
...
* introduce SparseEmbedding
* reno
* add to pydoc config
2024-03-19 18:04:16 +01:00
Silvano Cerza
2a83eccf99
Update docs renderer ( #7349 )
2024-03-13 12:30:13 +01:00
Tobias Wochinger
a3a21947a4
docs: disable class def rendering ( #7329 )
2024-03-07 15:54:16 +01:00
Madeesh Kannan
0db95fb7bd
docs: haystack.utils
docfixes ( #7318 )
2024-03-06 16:11:17 +01:00
Daria Fokina
2c7d1ead06
docs: edit audio docstrings order ( #7317 )
...
* audio docstrings order
* trigger CI
---------
Co-authored-by: anakin87 <stefanofiorucci@gmail.com>
2024-03-06 15:05:55 +01:00
Vladimir Blagojevic
c3caadb234
Add haystack.utils API docs ( #7311 )
2024-03-05 14:17:52 +01:00
Julian Risch
f0fb71da6f
docs: Add LostInTheMiddleRanker to API docs ( #7302 )
2024-03-05 09:49:46 +01:00
Silvano Cerza
247716f008
docs: Update joiners
docstrings and configs ( #7280 )
...
* Update joiners docstrings
* Update joiners docs config
2024-03-01 17:08:57 +01:00
Madeesh Kannan
b554e4cd49
docs: Update docstrings and API doc config for haystack.components.extractors
( #7251 )
...
* docs: Update docstrings and API doc config for `haystack.components.extractors`
* Review comments
2024-03-01 12:45:26 +01:00
David S. Batista
0ddb48b70f
docs: docstrings - generators.chat
( #7239 )
...
* fixing docstrings
* Update haystack/components/generators/chat/azure.py
Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>
* Update haystack/components/generators/chat/openai.py
Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>
* Update haystack/components/generators/chat/hugging_face_tgi.py
Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>
* fixing docstrings
---------
Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>
2024-02-28 17:33:47 +01:00
Tobias Wochinger
f22d49944d
docs: review and normalize haystack.components.websearch
( #7236 )
...
* docs: review and normalize `haystack.components.websearch`
* fix: use correct type annotations
* refactor: use type from protocol
Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>
* Revert "refactor: use type from protocol"
This reverts commit 23d6f45cd763c39b98be1bff03639a90f2a01fac.
* docs: refactor according to comments
* build: correctly pin to 4.7
---------
Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>
2024-02-28 16:43:08 +01:00
Stefano Fiorucci
7b9704a93a
docs: review Routers
docstrings ( #7234 )
...
* wip
* review routers
* small fixes
* Update haystack/components/routers/conditional_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/conditional_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/file_type_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/file_type_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/file_type_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/file_type_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/metadata_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/metadata_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/text_language_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/text_language_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
* Update haystack/components/routers/text_language_router.py
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
---------
Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
2024-02-28 11:26:22 +01:00
Stefano Fiorucci
e194c08316
docs: review DocumentLanguageClassifier
docstrings ( #7210 )
...
* review DocumentLanguageClassifier docstrings
* fix
* improve pydoc config
2024-02-27 16:02:53 +01:00
Stefano Fiorucci
2580e053ad
fix wrong docs config ( #7224 )
2024-02-27 16:00:44 +01:00
Stefano Fiorucci
9b1d7926ae
preprocessors: review docstrings ( #7219 )
2024-02-27 15:51:23 +01:00
Vladimir Blagojevic
f5645a4454
Update API docs to include OutputAdapter, OpenAPIServiceConnector and OpenAPIServiceToFunctions ( #7076 )
2024-02-23 14:34:16 +01:00
ZanSara
62ab83a0a0
remove pydoc config ( #7060 )
2024-02-22 10:48:35 +01:00
Stefano Fiorucci
8a101701fa
fix docs config for evaluators ( #7006 )
2024-02-15 17:49:25 +01:00
Vladimir Blagojevic
5a8d02064b
feat: Add JsonSchemaValidator ( #6937 )
...
* Add JsonSchemaValidator
---------
Co-authored-by: Stefano Fiorucci <stefanofiorucci@gmail.com>
2024-02-15 14:07:01 +01:00
Silvano Cerza
cb42ac19ae
docs: Add eval Components docs config ( #6984 )
...
* Add eval components docs config
* Update order
Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>
---------
Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>
2024-02-14 16:57:01 +01:00
Silvano Cerza
f96eb3847f
refactor: Merge Pipeline
s definition in core
package ( #6973 )
...
* Move marshalling functions in core Pipeline
* Move telemetry gathering in core Pipeline
* Move run logic in core Pipeline
* Update root Pipeline import
* Add release notes
* Update Pipeline docs path
* Update releasenotes/notes/merge-pipeline-definitions-1da80e9803e2a8bb.yaml
Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>
---------
Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>
2024-02-12 18:25:28 +01:00
Bijay Gurung
74683fe74d
Feat: Add FilterRetriever ( #6836 )
...
* Add FilterRetriever draft
* Implement FilterRetriever and add tests
* Update comparison to compare whole docs instead of just contents
* Expose FilterRetriever at the retrievers level
* Update docstring (add example usage)
* Add filter_retriever in the API reference docs config
Update retriever search path to start one dir level higher
* simplify _documents_equal
* improve usage example
---------
Co-authored-by: anakin87 <stefanofiorucci@gmail.com>
2024-02-08 08:48:46 +01:00
Massimiliano Pippi
27d0b28d06
chore: rename categories in the API docs ( #6885 )
...
* rename API categories
* fix
* update slugs
* rename files for consistency
* fix category ID
* try getting the right version
2024-02-01 16:47:26 +01:00
Massimiliano Pippi
acf4cd502f
refact: Rename helper function ( #6831 )
...
* change function name
* add api docs
* release notes
2024-01-26 16:00:02 +01:00
Massimiliano Pippi
4efe40664c
use haystack-pydoc-tools package instead of local code ( #6818 )
2024-01-23 18:28:52 +01:00
Daria Fokina
5d300a7356
add missing components to docs ( #6813 )
2024-01-23 14:03:15 +01:00
Daria Fokina
1841aec11e
docs: reorder and rename Classifier and CacheChecker files ( #6726 )
...
* docs: reorder
* others's order
* whisper order
2024-01-11 16:33:45 +01:00
Massimiliano Pippi
e1ec4e5e4d
refact!: Remove symbols under the haystack.document_stores
namespace ( #6714 )
...
* remove symbols under the haystack.document_stores namespace
* Update haystack/document_stores/types/protocol.py
Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>
* fix
* same for retrievers
* leftovers
* more leftovers
* add relnote
* leftovers
* one more
* fix examples
---------
Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>
2024-01-10 21:20:42 +01:00
Massimiliano Pippi
93b2aaee09
chore: move DocumentJoiner
to new joiners
package ( #6692 )
...
* move DocumentJoiner to new joiners package
* relnote
* leftovers
* fix docstrings generation
* fix unrelated pydoc misconfiguration
* more unrelated work, yay!
* fix assertions
2024-01-08 22:06:27 +01:00
Daria Fokina
d61ac9e6ae
docs: docstrings formatting ( #6677 )
...
* docs: docstrings formatting
* indent
2024-01-02 15:28:01 +01:00
ZanSara
5a68bb10c1
add doc config for others module ( #6604 )
2023-12-20 11:34:54 +01:00
Massimiliano Pippi
38bd367b74
fix pydoc config ( #6496 )
2023-12-06 15:02:07 +01:00
Daria Fokina
3fedd9f67f
docs: add Data Classes API ref and cleanup ( #6482 )
...
* Data Classes and cleanup
* Update pydoc-markdown.sh
* Update converter.yml
2023-12-04 14:03:28 +01:00
Massimiliano Pippi
09e7831f60
clean up 1.x code
...
---------
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>
2023-11-24 11:47:47 +01:00
Stefano Fiorucci
fdae81eee8
add pptx to API reference ( #6404 )
2023-11-23 18:02:31 +01:00
Christian Clauss
6dd52d91b2
ci: Fix typos discovered by codespell ( #5778 )
...
* Fix typos discovered by codespell
* pylint: max-args = 38
2023-09-13 16:14:45 +02:00
Stefano Fiorucci
cfc75dfdd5
rm sklearn from query-classifier.yml ( #5796 )
2023-09-13 15:03:22 +02:00
Christian Clauss
23f7308bec
ci: pre-commit autoupdate ( #5777 )
2023-09-12 14:34:41 +02:00
Agnieszka Marzec
e7532c49cf
Add cohere ranker api ( #5549 )
2023-08-11 17:47:36 +02:00
Daria Fokina
99cb95a63a
docs: separate abstract classes into separate API references ( #5501 )
...
* separate_abstractions
* img-to-text parent slug upd
* Apply suggestions from code review
Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>
---------
Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>
2023-08-07 12:21:25 +02:00
bogdankostic
a26859f065
docs: Add inherited methods to API reference documentation ( #5273 )
...
* Add inherited methods to API reference documentation
* Fix typing
2023-08-02 18:54:15 +02:00
Vladimir Blagojevic
1876c41f07
feat: Add LostInTheMiddleRanker ( #5457 )
...
* Add lost in the middle ranker
* Add release note
* Julian's feedback: more precise version of truncate
* Better comments for the litm algorithm
* Sebastian PR feedback
* Add check for invalid values of word_count_threshold
* Remove _truncate as it is not needed any more
---------
Co-authored-by: Darja Fokina <daria.f93@gmail.com>
2023-08-02 17:05:13 +02:00
Bilge Yücel
37bdfddff5
Fix Agent API ( #5483 )
...
* Fix agent.yml for new modules
* Fix ConversationalAgent docstrings
2023-08-01 17:05:13 +03:00
Vladimir Blagojevic
540d0fad97
feat: Add DiversityRanker ( #5398 )
...
* Introduce DiversityRanker
* improve most_diverse_order speed
* Compute mean for numerical stability
* Add release note
* Add cosine similarity
* Test both dot product and cosine similarity
* Add pydocs hook
---------
Co-authored-by: Michel Bartels <login@michelbartels.com>
2023-08-01 12:48:34 +02:00
Bilge Yücel
62029ba441
Add AgentStep to api reference ( #5402 )
2023-07-31 19:26:34 +03:00
Stefano Fiorucci
672813052d
Update invocation-layers.yml ( #5445 )
2023-07-26 15:39:08 +02:00
bogdankostic
345dbeb638
docs: Add Elasticsearch to API config ( #5422 )
2023-07-24 16:23:13 +02:00
elundaeva
612c6779fb
feat: RecentnessRanker ( #5301 )
...
* recency reranker code
* removed
* readd
* edited code
* edit
* mypy test fix
* adding warnings for score method
* fix
* fix
* adding paper link
* comments implementation
* change to predict and predict_batch
* change to predict and predict_batch 2
* adding unit test
* fixes
* small fixes
* fix for unit test
* table driven test
* small fixes
* small fixes2
* adding predict_batch tests
* add recentness_ranker to api reference docs
* implementing feedback
* implementing feedback2
* implementing feedback3
* implementing feedback4
* implementing feedback5
* remove document_map, remove final check if score is not None
* add final check if doc score is not None for mypy
---------
Co-authored-by: Darja Fokina <daria.f93@gmail.com>
Co-authored-by: Julian Risch <julian.risch@deepset.ai>
2023-07-20 16:20:45 +02:00
Vladimir Blagojevic
f21005f8ea
refactor: Extract link retrieval from WebRetriever, introduce LinkContentRetriever ( #5227 )
...
* Extract link retrieval from WebRetriever, introduce LinkContentRetriever
* Add example
---------
Co-authored-by: Stefano Fiorucci <44616784+anakin87@users.noreply.github.com>
Co-authored-by: Daria Fokina <daria.f93@gmail.com>
2023-07-13 12:54:40 +02:00