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.7.tar.gz (88.6 kB view details)

Uploaded Source

Built Distribution

fireworks_ai-0.15.7-py3-none-any.whl (109.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fireworks_ai-0.15.7.tar.gz
  • Upload date:
  • Size: 88.6 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.7.tar.gz
Algorithm Hash digest
SHA256 70193f1f81954f49a88ba85d77f4a7f42bdb5ac5ffc9f9aa72ba83aef20df22f
MD5 da19f9032bf7f2caabde34dd94fb33fa
BLAKE2b-256 d20fd204da3ea0b1637bfec575ed0b9dd88609bfb59b2b36f21b581bf7d90bc6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fireworks_ai-0.15.7-py3-none-any.whl
Algorithm Hash digest
SHA256 44d6985e245b70e3417c5800a3ef1a1710e2827469f42dab356a82d17d44a45e
MD5 57a5aa74fd70ff5104371b98bc5d3f03
BLAKE2b-256 d5c01d2748d64d33c2db611e6218743367f1d588f13fe076f95cee784708d7b8

See more details on using hashes here.

Supported by

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