70 Commits

Author SHA1 Message Date
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
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
Silvano Cerza
9a359101fd
chore: Rework docs generation (#5481)
* Change docs generation to use id for parent doc instead of slug

* Rename step
2023-08-01 12:18:33 +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
Massimiliano Pippi
a13ffcf9df
bump pydoc-markdown (#5405) 2023-07-20 16:48:08 +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
bogdankostic
c2506866bd
docs: Pin PyYAML to 5.3.1 (#5400) 2023-07-20 15:31:58 +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
Daria Fokina
a152a812da
create invocation-layers API reference page (#5262)
* create invocation-layers.yml

* Update invocation-layers.yml
2023-07-12 17:48:27 +02:00
Silvano Cerza
d6f855cbc5
chore: Add support for hierarchical docs (#5278)
Co-authored-by: bogdankostic <bogdankostic@web.de>
2023-07-07 17:00:29 +02:00
Daria Fokina
181a277f60
Update agent.yml (#5222) 2023-06-28 21:14:11 +02:00
bogdankostic
6a5fbb7118
docs: Remove transformers module from AnswerGenerator API docs (#5185) 2023-06-21 17:20:25 +02:00
Bilge Yücel
6a1b6b1ae3
feat: Update ConversationalAgent (#5065)
* feat: Update ConversationalAgent

* Add Tools
* Add test
* Change default params

* fix tests

* Fix circular import error
* Update conversational-agent prompt
* Add conversational-agent-without-tools to legacy list

* Add warning to add tools to conversational agent

* Add callable tools

* Add example script

* Fix linter errors

* Update ConversationalAgent depending on the existance of tools

* Initialize the base Agent with different arguments when there's tool
* Inject memory to the prompt in both cases, update prompts accordingly

* Override the add_tools method to prevent adding tools to ConversationalAgent without tools

* Update test

* Fix linter error

* Remove unused import

* Update docstrings and api reference

* Fix imports and doc string code snippet

* docstrings update

* Update conversational.py

* Mock PromptNode

* Prevent circular import error

* Add max_steps to the ConversationalAgent

* Update resolver description

* Add prompt_template as parameter

* Change docstring

---------

Co-authored-by: Darja Fokina <daria.f93@gmail.com>
2023-06-20 13:09:21 +03:00
Massimiliano Pippi
00bee17b79
fix: remove old dependency from file-converters.yml (#4999) 2023-05-23 17:27:04 +02:00
dependabot[bot]
8a45be5733
build(deps): bump requests from 2.28.2 to 2.31.0 in /docs/pydoc (#4984)
Bumps [requests](https://github.com/psf/requests) from 2.28.2 to 2.31.0.
- [Release notes](https://github.com/psf/requests/releases)
- [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md)
- [Commits](https://github.com/psf/requests/compare/v2.28.2...v2.31.0)

---
updated-dependencies:
- dependency-name: requests
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-23 08:26:38 +02:00
Massimiliano Pippi
8228081e7a
chore: leftovers from removing knowledge graph support (#4974)
* leftovers from removing knowledge graph support

* more leftovers
2023-05-22 10:03:51 +02:00
Massimiliano Pippi
4974bf7ab3
chore: remove deprecated MilvusDocumentStore (#4951)
* remove deprecated MilvusDocumentStore

* remove leftovers

* fix pylint
2023-05-19 16:37:38 +02:00
Vladimir Blagojevic
73380b194a
feat: Add Cohere PromptNode invocation layer (#4827)
* Add CohereInvocationLayer
---------

Co-authored-by: bogdankostic <bogdankostic@web.de>
2023-05-12 17:50:09 +02:00
Daria Fokina
7ef6bd8373
[Docs] Hide api classes in prompt_node (#4869)
* hide api classes in prompt_node

* add jsonconverter to docs
2023-05-10 10:56:46 +02:00
Daria Fokina
dbbdc5464a
docs: fix Prompt_Node and Pipelines API reference (#4858)
* fix: Prompt_Node and Pipelines API reference

* deleted invocation layers
2023-05-09 19:04:55 +02:00
Vladimir Blagojevic
650e1a1a6f
fix: gpt-3.5-turbo is an agent streaming model (#4673)
* gpt-3.5 is also agent streaming model

* Add more streaming capable models

* Add end-of-file-fixer

* List full model names for clarity
2023-04-26 13:56:24 +02:00
Darja Fokina
ec7fc4aa0b
docs: add web retriever to api docs (#4699) 2023-04-18 17:19:57 +02:00
Vladimir Blagojevic
1dcac11133
feat: Add Hugging Face inferencing PromptNode layer (#4641) 2023-04-14 17:59:17 +02:00