Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update FAQ.md with api_base vs base_url question #672

Merged
merged 1 commit into from
Nov 18, 2023
Merged

Conversation

gagb
Copy link
Collaborator

@gagb gagb commented Nov 14, 2023

Why are these changes needed?

added a faq for api_base vs base_url because people were asking about it frequently.

Related issue number

Checks

added a faq for api_base vs base_url because people were asking about it frequently.
@gagb gagb requested review from sonichi, rickyloynd-microsoft and a team November 14, 2023 01:54
@gagb gagb marked this pull request as ready for review November 14, 2023 01:54
@codecov-commenter
Copy link

codecov-commenter commented Nov 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a5e3c9d) 28.70% compared to head (4a6549d) 28.70%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #672   +/-   ##
=======================================
  Coverage   28.70%   28.70%           
=======================================
  Files          27       27           
  Lines        3383     3383           
  Branches      760      760           
=======================================
  Hits          971      971           
  Misses       2341     2341           
  Partials       71       71           
Flag Coverage Δ
unittests 28.64% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@rickyloynd-microsoft rickyloynd-microsoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!

@gagb gagb added the documentation Improvements or additions to documentation label Nov 14, 2023
@sonichi
Copy link
Contributor

sonichi commented Nov 14, 2023

@rickyloynd-microsoft
Copy link
Contributor

Do we need it given: https://microsoft.github.io/autogen/docs/Installation#migration-guide-to-v02 ?

I think the repetition is helpful for people who don't carefully read or remember the migration guide, and people who pick up an old piece of code from somewhere without realizing there was an API migration.

Copy link
Collaborator

@BeibinLi BeibinLi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@BeibinLi
Copy link
Collaborator

Alternatively, should we check "api_base" and "base_url" in the config dictionary, and decide which one to use based on the OpenAI Version?

@sonichi
Copy link
Contributor

sonichi commented Nov 15, 2023

Do we need it given: https://microsoft.github.io/autogen/docs/Installation#migration-guide-to-v02 ?

I think the repetition is helpful for people who don't carefully read or remember the migration guide, and people who pick up an old piece of code from somewhere without realizing there was an API migration.

How about adding a link to the migration guide page too?

@sonichi
Copy link
Contributor

sonichi commented Nov 15, 2023

Alternatively, should we check "api_base" and "base_url" in the config dictionary, and decide which one to use based on the OpenAI Version?

That's also a good idea.

@sonichi sonichi added this pull request to the merge queue Nov 18, 2023
Merged via the queue into main with commit 1b1cfaf Nov 18, 2023
16 checks passed
@sonichi sonichi deleted the gagb-patch-1 branch December 3, 2023 23:53
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
added a faq for api_base vs base_url because people were asking about it frequently.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants