Skip to content

[ENH](ef): Add Azure OpenAI deployment alias#7101

Open
ARasugit20 wants to merge 1 commit into
chroma-core:mainfrom
ARasugit20:prototype/azure-openai-alias-and-errors
Open

[ENH](ef): Add Azure OpenAI deployment alias#7101
ARasugit20 wants to merge 1 commit into
chroma-core:mainfrom
ARasugit20:prototype/azure-openai-alias-and-errors

Conversation

@ARasugit20
Copy link
Copy Markdown

Accept azure_deployment as a constructor alias for deployment_id so Azure OpenAI users can use the same parameter name as the OpenAI SDK without changing Chroma's persisted embedding function config.

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • ...
  • New functionality
    • ...

Test plan

How are these changes tested?

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

Migration plan

Are there any migrations, or any forwards/backwards compatibility changes needed in order to make sure this change deploys reliably?

Observability plan

What is the plan to instrument and monitor this change?

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs section?

Accept azure_deployment as a constructor alias for deployment_id so
Azure OpenAI users can use the same parameter name as the OpenAI SDK
without changing Chroma's persisted embedding function config.
@github-actions
Copy link
Copy Markdown

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant