yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-06-26 22:00:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
3,333 Commits 73 Branches 239 Tags
Commit Graph

102 Commits

Author SHA1 Message Date
Julian Risch
b12e0db134
feat: Add ContextRelevanceEvaluator component (#7519) 
* feat: Add ContextRelevanceEvaluator component

* reno

* fix expected inputs and example docstring

* remove responses parameter from tests

* specify inputs explicitly

* add new evaluator to api reference docs
 2024-04-22 14:10:00 +02:00
Daria Fokina
a5f6571cfb
docs: add evaluators component reference (#7532) 2024-04-12 12:51:39 +02:00
Stefano Fiorucci
eff53a9131
feat: HuggingFaceAPIDocumentEmbedder (#7485) 
* add HuggingFaceAPITextEmbedder

* add HuggingFaceAPITextEmbedder

* rm unneeded else

* wip

* small fixes

* deprecation; reno

* Apply suggestions from code review

Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>

* make params mandatory

* changes requested

* fix test

* fix test

---------

Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
 2024-04-08 15:06:26 +02:00
Stefano Fiorucci
c91bd49cae
feat: HuggingFaceAPITextEmbedder (#7484) 
* add HuggingFaceAPITextEmbedder

* add HuggingFaceAPITextEmbedder

* rm unneeded else

* small fixes

* changes requested

* fix test
 2024-04-08 14:22:54 +02:00
Stefano Fiorucci
0dbb98c0a0
feat: HuggingFaceAPIChatGenerator (#7480) 
* draft

* docstrings and more tests

* deprecation; reno

* pydoc config

* better error messages

* wip

* add test

* better docstrings

* deprecation; reno

* pylint

* typo

* rm unneeded else

* rm unneeded else

* fixes from feedback

* docstring showing the enum

* improve docstring

* make params mandatory

* Apply suggestions from code review

Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>

* document enum

* Update haystack/utils/hf.py

Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>

* mandatory params

* fix test

* fix test

---------

Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
 2024-04-05 18:48:34 +02:00
Stefano Fiorucci
1d083861ff
feat: HuggingFaceAPIGenerator (#7464) 
* draft

* docstrings and more tests

* deprecation; reno

* pydoc config

* better error messages

* rm unneeded else

* make params mandatory

* Apply suggestions from code review

Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>

* document enum

* Update haystack/utils/hf.py

Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>

* fix test

---------

Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
 2024-04-05 18:48:13 +02:00
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 Pipelines 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
a86807b834
move Cohere generator into dedicated integration (#6475) 2023-12-04 11:16:12 +01:00
Daria Fokina
675302981b
docs: add CohereGenerator and ConditionalRouter (#6455) 2023-11-30 14:59:14 +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
Vladimir Blagojevic
e04a1f16bb
feat: Add DynamicPromptBuilder to Haystack 2.x (#6328) 
* Add DynamicPromptBuilder

* Improve pydocs, add unit tests

* Add release note

* Make expected_runtime_variables optional

* Add pydocs usage example

* Add more pydocs

* Remove test markers

* Update type in unit test

* Update after canals upgrade

* add to api ref

* docstrings updates

* Update test/preview/components/builders/test_dynamic_prompt_builder.py

Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>

* Update haystack/preview/components/builders/dynamic_prompt_builder.py

Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>

* Deparametrize init test

* Rename expected_runtime_variables to runtime_variables

* Rephrase docstring so meaning is clearer

---------

Co-authored-by: Darja Fokina <daria.f93@gmail.com>
Co-authored-by: Daria Fokina <daria.fokina@deepset.ai>
Co-authored-by: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com>
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>
 2023-11-23 11:41:57 +01:00
Vladimir Blagojevic
cfff0d5212
Rename file_converters to converters (#6390) 2023-11-23 10:28:40 +01:00
Julian Risch
939e443ee8
docs: Add DocumentJoiner to API docs (#6365) 2023-11-20 18:18:06 +01:00
Stefano Fiorucci
f74f034549
fix pydoc config (#6313) 2023-11-15 15:32:29 +01:00
Daria Fokina
34136382c1
docs: 2.0 API reference (#6262) 
* docs: 2.0 API reference

* add builders and generators

* classifiers file path
 2023-11-14 10:12:28 +01:00
Julian Risch
db36d6277a
docs: Add readme sync for API docs 2.0 (#6173) 
* add sync docs for preview

* add example config for audio docs

* hardcode version in renderer

* use custom renderer for preview docs

* update comment and excerpt
 2023-10-27 14:53:03 +02:00