Skip to main content

Python client library for the Fireworks.ai Generative AI Platform

Project description

Fireworks.ai Python library

Fireworks.ai Python Library provides a convenient API for accessing Fireworks supported LLMs. We are targeting our API to be very similar to OpenAI's API so you can replace OpenAI usage with minimal modifications

Installation

pip install --upgrade fireworks-ai

API definitions

Please check our completion and chat completion API reference for the arguments we support and the meaning of each arguments.

Example code

List

import fireworks.client
fireworks.client.api_key = "your-key"
print(fireworks.client.Model.list())
object='list' data=[Model(id="accounts/fireworks/models/llama-v2-7b", object="model", created=0), ...]

Completion

import fireworks.client
fireworks.client.api_key = "your-key"
completion = fireworks.client.Completion.create("accounts/fireworks/models/llama-v3-8b-instruct", "Once upon a time", temperature=0.1, n=2, max_tokens=16)
print(completion)
id='8bd3ac8f-a7d3-4dab-a19e-cea3f9c83f1e' object='text_completion' created=1714831539 model='accounts/fireworks/models/llama-v3-8b-instruct' choices=[Choice(index=0, text=', there was a young girl named Sophia who lived in a small village surrounded by', logprobs=None, finish_reason='length', raw_output=None), Choice(index=1, text=', there was a small village nestled in the heart of a dense forest. The', logprobs=None, finish_reason='length', raw_output=None)] usage=UsageInfo(prompt_tokens=4, total_tokens=36, completion_tokens=32)

Streaming completion

import fireworks.client
fireworks.client.api_key = "your-key"
for completion in fireworks.client.Completion.create(
    "accounts/fireworks/models/llama-v3-8b-instruct",
    prompt="Once upon a time",
    temperature=0.1,
    n=2,
    max_tokens=16
):
    print(completion)

Async completion

import asyncio
import fireworks.client
fireworks.client.api_key = "your-key"
async def main():
    response = await fireworks.client.Completion.acreate("accounts/fireworks/models/llama-v3-8b-instruct", "Once upon a time", echo=True, max_tokens=16)
    print(response.choices[0].text)
asyncio.run(main())

then run the script

$ python test.py
Once upon a time, there used to be a huge mountain that was the most famous mou

ChatCompletion

import fireworks.client
fireworks.client.api_key = "your-key"
completion = fireworks.client.ChatCompletion.create(
    "accounts/fireworks/models/llama-v3-8b-instruct",
    messages=[{"role": "user", "content": "Hello there!"}],
    temperature=0.7,
    n=2,
    max_tokens=16
)
print(completion)
id='cmpl-ec241c8f5b8d50bcf792f2df' object='chat.completion' created=1691896960 model='accounts/fireworks/models/llama-v2-7b-chat' choices=[ChatCompletionResponseChoice(index=0, message=ChatMessage(role='assistant', content=" Hello! It's nice to meet you. Is there something I can"), finish_reason='length'), ChatCompletionResponseChoice(index=1, message=ChatMessage(role='assistant', content=" Hello! It's nice to meet you. Is there something I can"), finish_reason='length')] usage=UsageInfo(prompt_tokens=23, total_tokens=55, completion_tokens=32)

Requirements

  • Python 3.7

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fireworks_ai-0.15.5.tar.gz (87.7 kB view details)

Uploaded Source

Built Distribution

fireworks_ai-0.15.5-py3-none-any.whl (108.8 kB view details)

Uploaded Python 3

File details

Details for the file fireworks_ai-0.15.5.tar.gz.

File metadata

  • Download URL: fireworks_ai-0.15.5.tar.gz
  • Upload date:
  • Size: 87.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for fireworks_ai-0.15.5.tar.gz
Algorithm Hash digest
SHA256 19c2e30db205fd2f1d7fa269489d0106fe50cdb60dbc2c4d9da59a89b1b97e63
MD5 8d06e73724185da99c4698c4a9dbcff6
BLAKE2b-256 f32be3747a6c9ad58968bde32052b58cc53eb9eb2e970337f9c1c9d2de79ca9f

See more details on using hashes here.

File details

Details for the file fireworks_ai-0.15.5-py3-none-any.whl.

File metadata

  • Download URL: fireworks_ai-0.15.5-py3-none-any.whl
  • Upload date:
  • Size: 108.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for fireworks_ai-0.15.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8231a23e632034258e337df1383e4a95018df7778b9abaf57e43cf31866c06f4
MD5 bdfd453eecc53a7fa3167cc8dd259ff3
BLAKE2b-256 2bda7113e21ae471c062a634b613392682bf2c086b4632ac7b9e07c3301076a4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page