Skip to content

Repository files navigation

Gooey Python Library

fern shieldpypi

The Gooey Python library provides convenient access to the Gooey API from Python.

🧑‍💻 Who is this for and why would I want to use it?

  • Any developer who wants to quickly prototype with GenAI apps
  • Great for those who want to include GenAI in their existing product or app
  • Gooey.AI SDKs are great for speedy GTMs as we are already built to scale!

Try it on Colab

Open In Colab

Installation

pip install gooeyai

Usage

Instantiate and use the client with the following:

fromgooeyimportGooeyclient=Gooey(
api_key="YOUR_API_KEY",
)
client.bulk_runner(
documents=["documents"],
run_urls=["run_urls"],
input_columns={"key": "value"},
output_columns={"key": "value"},
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API.

importasynciofromgooeyimportAsyncGooeyclient=AsyncGooey(
api_key="YOUR_API_KEY",
)
asyncdefmain() ->None:
awaitclient.bulk_runner(
documents=["documents"],
run_urls=["run_urls"],
input_columns={"key": "value"},
output_columns={"key": "value"},
)
asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

fromgooey.core.api_errorimportApiErrortry:
client.bulk_runner(...)
exceptApiErrorase:
print(e.status_code)
print(e.body)

Advanced

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.bulk_runner(..., {
"max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

fromgooeyimportGooeyclient=Gooey(
...,
timeout=20.0,
)
# Override timeout for a specific methodclient.bulk_runner(..., {
"timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

importhttpxfromgooeyimportGooeyclient=Gooey(
...,
httpx_client=httpx.Client(
proxies="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

About

SDK for developers to use Gooey in their applications

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages