feat: check document store and retriever dimensions before calculating embeddings for all documents

[AnushreeBannadabhavi]

Related Issues

• fixes Check document_store and embedding_model dimensions before calculating embeddings #5188

Proposed Changes:

• Currently, in haystack v1.x, when document_store.update_embeddings() gets called, the embeddings are calculated for all the documents and then saved to the document store. If the embedding dimension set in the document store differs from that of the retriever model, a runtime error is raised.
• However, we don't need to calculate embeddings for all the documents in the document store to raise this error. This is especially an issue when using paid APIs (openai) or when the embedding calculation is time consuming.
• A more efficient alternative is to calculate the embedding of a single document and verify that the embedding dimensions match between the document store and the retriever.

How did you test it?

• Added two unit tests in test_faiss.py
• Modified the basic_faq_pipeline.py to test the change.
  - Used FAISSDocumentStore instead of ElasticsearchDocumentStore. I instantiated the docustore without the embedding_dim parameter. Therefore the default value 768 is set in the docustore making the embedding dimension of the retriever and docustore different.

Notes for the reviewer

The same feature can be added in other document stores: memory.py, mongodb_atlas.py, pinecone.py, search_engine.py and weaviate.py. Once this change is reviewed and looks fine, I can add it in the other document stores too.

Checklist

• I have read the contributors guidelines and the code of conduct
• I have updated the related issue with new insights and changes
• I added unit tests and updated the docstrings
• I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test:.
• I documented my code
• I ran pre-commit hooks and fixed any issue

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
7 out of 9 committers have signed the CLA.

✅ silvanocerza
✅ dfokina
✅ shadeMe
✅ davidsbatista
✅ dcbark01
✅ Lord-Haji
✅ awinml
❌ bilgeyucel
❌ wochinge
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[AnushreeBannadabhavi]

I accidentally did a force push. I'll just close this PR and open a new one instead of reverting the push