feat: initial #1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Isac Byeonghoon Yoo <isac@runbear.io>
isac322
commented
Dec 19, 2023
Comment on lines
+47
to
+87
| ## Other Web server frameworks | ||
|
|
||
| Although it does not yet provide an interface as convenient as FastAPI, it can be directly linked to PlugBear. | ||
|
|
||
| ### Installation | ||
|
|
||
| To install the PlugBear Python SDK, run the following command: | ||
|
|
||
| ```bash | ||
| pip install plugbear | ||
| ``` | ||
|
|
||
| ### Usage | ||
|
|
||
| ```python | ||
| from fastapi import FastAPI | ||
|
|
||
| import plugbear | ||
| import plugbear.fastapi | ||
|
|
||
| app = FastAPI() | ||
| PLUGBEAR_API_KEY = "" | ||
| PLUGBEAR_ENDPOINT = "/plugbear" | ||
|
|
||
|
|
||
| @app.on_event("startup") | ||
| async def _startup(): | ||
| await plugbear.fastapi.register( | ||
| app, | ||
| llm_func=some_llm, | ||
| api_key=PLUGBEAR_API_KEY, | ||
| endpoint=PLUGBEAR_ENDPOINT, | ||
| ) | ||
|
|
||
|
|
||
| async def some_llm(context: plugbear.Request) -> str: | ||
| # template prompt using `context` to your own LLM | ||
| # and return result | ||
| result: str = ... | ||
| return result | ||
| ``` |
Member
Author
There was a problem hiding this comment.
만들고보니 인터페이스를 나눠놔서 꼭 fastapi가 아니더라도 api handler에 잘 붙이기만하면 연동될 것 같아서 이 항목도 넣었는데 어떠신가요? usage 항목은 간단한 django예시를 적어놓으면 어떨까 생각했습니다..!
Member
There was a problem hiding this comment.
Great, I like it! Also, as we're publishing this package, let's ensure all communications in this repository are in English for consistency and clarity.
thefron
approved these changes
Dec 19, 2023
Comment on lines
+47
to
+87
| ## Other Web server frameworks | ||
|
|
||
| Although it does not yet provide an interface as convenient as FastAPI, it can be directly linked to PlugBear. | ||
|
|
||
| ### Installation | ||
|
|
||
| To install the PlugBear Python SDK, run the following command: | ||
|
|
||
| ```bash | ||
| pip install plugbear | ||
| ``` | ||
|
|
||
| ### Usage | ||
|
|
||
| ```python | ||
| from fastapi import FastAPI | ||
|
|
||
| import plugbear | ||
| import plugbear.fastapi | ||
|
|
||
| app = FastAPI() | ||
| PLUGBEAR_API_KEY = "" | ||
| PLUGBEAR_ENDPOINT = "/plugbear" | ||
|
|
||
|
|
||
| @app.on_event("startup") | ||
| async def _startup(): | ||
| await plugbear.fastapi.register( | ||
| app, | ||
| llm_func=some_llm, | ||
| api_key=PLUGBEAR_API_KEY, | ||
| endpoint=PLUGBEAR_ENDPOINT, | ||
| ) | ||
|
|
||
|
|
||
| async def some_llm(context: plugbear.Request) -> str: | ||
| # template prompt using `context` to your own LLM | ||
| # and return result | ||
| result: str = ... | ||
| return result | ||
| ``` |
Member
There was a problem hiding this comment.
Great, I like it! Also, as we're publishing this package, let's ensure all communications in this repository are in English for consistency and clarity.
| async def register(app: fastapi.FastAPI, *, llm_func: LLMHandler, api_key: str, endpoint: str) -> None: | ||
| pb = await plugbear.PlugBear.init(api_key=api_key) | ||
|
|
||
| if inspect.iscoroutinefunction(llm_func): |
Member
There was a problem hiding this comment.
I like we support both coroutine and regular subroutine.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
우선 ci 빼고 코드만 리뷰 요청드려요.