[ENH] Removing new line cleanup from OpenAI EF (python)

[tazarov]

Closes #2129

• Align with the JS OpenAI EF which doesn't remove new lines
• The statement that new lines negatively impact performance is no longer true - Why does newline negatively impact embedding performance? openai/openai-python#418
• OpenAI client no longer removes new lines (embedding_utils.py was removed in v1)
• Align with what other ecosystem players (Langchain) where new lines are also not removed https://github.com/langchain-ai/langchain/blob/70bde154807cbe434dfa7c059a43db6796b6b3e7/libs/partners/openai/langchain_openai/embeddings/base.py#L461-L489
• Users in discord have reported similarity score of Chroma and direct OpenAI client embeddings of the same string as low as 98% (https://discord.com/channels/1073293645303795742/1074711816900456519/1235657579812880444)

Description of changes

Summarize the changes made by this PR.

• Improvements & Bug fixes
  • New line removal from OpenAI inputs is not required

Test plan

How are these changes tested?

• Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

N/A

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
chroma	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 3, 2024 1:34pm

[tazarov]

• [ENH] Removing new line cleanup from OpenAI EF (python) #2125 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

• Can you think of any use case in which the code does not behave as intended? Have they been tested?
• Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
• If appropriate, are there adequate property based tests?
• If appropriate, are there adequate unit tests?
• Should any logging, debugging, tracing information be added or removed?
• Are error messages user-friendly?
• Have all documentation changes needed been made?
• Have all non-obvious changes been commented?

System Compatibility

• Are there any potential impacts on other parts of the system or backward compatibility?
• Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

• Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

[atroyn]

I agree that this is correct. However, this may impact people who already have collections using the old EF.

They would have to migrate, and we should let them know when we release this. Assigning myself here so that I remember to do this when this releases.

[tazarov]

I had similar realization that users' new queries will have slightly worse outcome for exact matches, but perhaps that would be marginal. I'll do a small test to prove myself wrong

[tazarov]

Another minutiae from my investigation was that non-code first gen models (-001) need new line removal, but it feels that while available from API perspective are being silently phased out by OpenAI (couldn't find refs on the latest embeddings OAI docs).

[atroyn]

I had similar realization that users' new queries will have slightly worse outcome for exact matches, but perhaps that would be marginal. I'll do a small test to prove myself wrong

Whether or not this makes retrieval accuracy worse, users may be relying on the embeddings themselves, e.g. for deduplication. We must notify them after this change.

[tazarov]

I had similar realization that users' new queries will have slightly worse outcome for exact matches, but perhaps that would be marginal. I'll do a small test to prove myself wrong

Whether or not this makes retrieval accuracy worse, users may be relying on the embeddings themselves, e.g. for deduplication. We must notify them after this change.

Will it make sense to add a flag (constructor param) so that whoever needs/uses new line removals can do so going forward? But perhaps making an opt-in thing by default + the warning for the change.

[atroyn]

I think we should just pull the trigger and not complicate the interface with cruft, while ensuring we communicate to users.