Skip to content

Fireworks

Fireworks #

Bases: OpenAI

Fireworks LLM with support for custom models.

Examples:

pip install llama-index-llms-fireworks

from llama_index.llms.fireworks import Fireworks

# Using predefined model
llm = Fireworks(
    model="accounts/fireworks/models/mixtral-8x7b-instruct",
    api_key="YOUR_API_KEY"
)

resp = llm.complete("Hello world!")
print(resp)

# Using custom model with context window
llm = Fireworks(
    model="accounts/fireworks/models/my-custom-model",
    api_key="YOUR_API_KEY",
    context_window=65536,
    is_function_calling=True
)
Source code in llama_index/llms/fireworks/base.py
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
class Fireworks(OpenAI):
    """
    Fireworks LLM with support for custom models.

    Examples:
        `pip install llama-index-llms-fireworks`

        ```python
        from llama_index.llms.fireworks import Fireworks

        # Using predefined model
        llm = Fireworks(
            model="accounts/fireworks/models/mixtral-8x7b-instruct",
            api_key="YOUR_API_KEY"
        )

        resp = llm.complete("Hello world!")
        print(resp)

        # Using custom model with context window
        llm = Fireworks(
            model="accounts/fireworks/models/my-custom-model",
            api_key="YOUR_API_KEY",
            context_window=65536,
            is_function_calling=True
        )
        ```

    """

    def __init__(
        self,
        model: str = DEFAULT_MODEL,
        temperature: float = DEFAULT_TEMPERATURE,
        max_tokens: int = DEFAULT_NUM_OUTPUTS,
        additional_kwargs: Optional[Dict[str, Any]] = None,
        max_retries: int = 10,
        api_base: Optional[str] = DEFAULT_API_BASE,
        api_key: Optional[str] = None,
        callback_manager: Optional[CallbackManager] = None,
        default_headers: Optional[Dict[str, str]] = None,
        system_prompt: Optional[str] = None,
        messages_to_prompt: Optional[Callable[[Sequence[ChatMessage]], str]] = None,
        completion_to_prompt: Optional[Callable[[str], str]] = None,
        pydantic_program_mode: PydanticProgramMode = PydanticProgramMode.DEFAULT,
        output_parser: Optional[BaseOutputParser] = None,
        context_window: Optional[int] = None,
        is_function_calling: Optional[bool] = None,
    ) -> None:
        additional_kwargs = additional_kwargs or {}
        callback_manager = callback_manager or CallbackManager([])

        api_base = get_from_param_or_env("api_base", api_base, "FIREWORKS_API_BASE")
        api_key = get_from_param_or_env("api_key", api_key, "FIREWORKS_API_KEY")

        super().__init__(
            model=model,
            temperature=temperature,
            max_tokens=max_tokens,
            api_base=api_base,
            api_key=api_key,
            additional_kwargs=additional_kwargs,
            max_retries=max_retries,
            callback_manager=callback_manager,
            default_headers=default_headers,
            system_prompt=system_prompt,
            messages_to_prompt=messages_to_prompt,
            completion_to_prompt=completion_to_prompt,
            pydantic_program_mode=pydantic_program_mode,
            output_parser=output_parser,
        )

        # Store custom model metadata
        self._custom_context_window: int | None = context_window
        self._custom_is_function_calling: bool | None = is_function_calling

    @classmethod
    def class_name(cls) -> str:
        return "Fireworks_LLM"

    def _get_context_window(self) -> int:
        """Get context window with fallback logic."""
        if self._custom_context_window is not None:
            return self._custom_context_window

        try:
            return fireworks_modelname_to_contextsize(self.model)
        except ValueError:
            return DEFAULT_CONTEXT_WINDOW

    def _get_is_function_calling(self) -> bool:
        """Get function calling status with fallback logic."""
        if self._custom_is_function_calling is not None:
            return self._custom_is_function_calling

        return is_function_calling_model(model=self._get_model_name())

    @property
    def metadata(self) -> LLMMetadata:
        return LLMMetadata(
            context_window=self._get_context_window(),
            num_output=self.max_tokens,
            is_chat_model=True,
            model_name=self.model,
            is_function_calling_model=self._get_is_function_calling(),
        )

    @property
    def _is_chat_model(self) -> bool:
        return True

options: members: - Fireworks