---
# AUTO-GENERATED API DOCUMENTATION - DO NOT EDIT
title: mirascope.core.groq.call_response_chunk
description: API documentation for mirascope.core.groq.call_response_chunk
---

# mirascope.core.groq.call_response_chunk

## <ApiType type="Module" path="core/groq/call_response_chunk" symbolName="call_response_chunk" /> call_response_chunk

This module contains the `GroqCallResponseChunk` class.

<Info title="Usage">

[Streams](/docs/v1/learn/streams#handling-streamed-responses)

</Info>

## <ApiType type="Attribute" path="core/groq/call_response_chunk" symbolName="FinishReason" /> FinishReason

**Type:** <TypeLink type={{"type_str": "Choice.__annotations__['finish_reason']", "description": null, "kind": "generic", "base_type": {"type_str": "Choice.__annotations__", "description": null, "kind": "simple", "doc_identifier": "Choice.__annotations__"}, "parameters": [{"type_str": "'finish_reason'", "description": null, "kind": "simple", "doc_identifier": "'finish_reason'"}]}} />


## <ApiType type="Class" path="core/groq/call_response_chunk" symbolName="GroqCallResponseChunk" /> GroqCallResponseChunk

A convenience wrapper around the Groq `ChatCompletionChunk` streamed chunks.

When calling the Groq API using a function decorated with `groq_call` and
`stream` set to `True`, the stream will contain `GroqResponseChunk` instances with
properties that allow for more convenient access to commonly used attributes.

Example:

```python
from mirascope.core import prompt_template
from mirascope.core.groq import groq_call


@groq_call("llama-3.1-8b-instant", stream=True)
def recommend_book(genre: str) -> str:
    return f"Recommend a {genre} book"

stream = recommend_book("fantasy")  # response is an `GroqStream`
for chunk, _ in stream:
    print(chunk.content, end="", flush=True)
```

**Bases:** 
<TypeLink type={{"type_str": "BaseCallResponseChunk[ChatCompletionChunk, FinishReason]", "description": null, "kind": "generic", "base_type": {"type_str": "BaseCallResponseChunk", "description": null, "kind": "simple", "doc_url": "/docs/v1/api/core/base/call_response_chunk#basecallresponsechunk"}, "parameters": [{"type_str": "ChatCompletionChunk", "description": null, "kind": "simple", "doc_identifier": "ChatCompletionChunk"}, {"type_str": "FinishReason", "description": null, "kind": "simple", "doc_url": "/docs/v1/api/core/openai/call_response_chunk#finishreason"}]}} />

<AttributesTable
  attributes={[
  {
    "name": "content",
    "type_info": {
      "type_str": "str",
      "description": null,
      "kind": "simple",
      "doc_url": "https://docs.python.org/3/library/stdtypes.html#str"
    },
    "description": "Returns the content for the 0th choice delta."
  },
  {
    "name": "finish_reasons",
    "type_info": {
      "type_str": "list[FinishReason]",
      "description": null,
      "kind": "generic",
      "base_type": {
        "type_str": "list",
        "description": null,
        "kind": "simple",
        "doc_url": "https://docs.python.org/3/library/stdtypes.html#list"
      },
      "parameters": [
        {
          "type_str": "FinishReason",
          "description": null,
          "kind": "simple",
          "doc_url": "/docs/v1/api/core/openai/call_response_chunk#finishreason"
        }
      ]
    },
    "description": "Returns the finish reasons of the response."
  },
  {
    "name": "model",
    "type_info": {
      "type_str": "str",
      "description": null,
      "kind": "simple",
      "doc_url": "https://docs.python.org/3/library/stdtypes.html#str"
    },
    "description": "Returns the name of the response model."
  },
  {
    "name": "id",
    "type_info": {
      "type_str": "str",
      "description": null,
      "kind": "simple",
      "doc_url": "https://docs.python.org/3/library/stdtypes.html#str"
    },
    "description": "Returns the id of the response."
  },
  {
    "name": "usage",
    "type_info": {
      "type_str": "CompletionUsage | None",
      "description": null,
      "kind": "union",
      "base_type": {
        "type_str": "Union",
        "description": null,
        "kind": "simple",
        "doc_url": "https://docs.python.org/3/library/typing.html#typing.Union"
      },
      "parameters": [
        {
          "type_str": "CompletionUsage",
          "description": null,
          "kind": "simple",
          "doc_identifier": "CompletionUsage"
        },
        {
          "type_str": "None",
          "description": null,
          "kind": "simple",
          "doc_url": "https://docs.python.org/3/library/constants.html#None"
        }
      ]
    },
    "description": "Returns the usage of the chat completion."
  },
  {
    "name": "input_tokens",
    "type_info": {
      "type_str": "int | None",
      "description": null,
      "kind": "union",
      "base_type": {
        "type_str": "Union",
        "description": null,
        "kind": "simple",
        "doc_url": "https://docs.python.org/3/library/typing.html#typing.Union"
      },
      "parameters": [
        {
          "type_str": "int",
          "description": null,
          "kind": "simple",
          "doc_url": "https://docs.python.org/3/library/functions.html#int"
        },
        {
          "type_str": "None",
          "description": null,
          "kind": "simple",
          "doc_url": "https://docs.python.org/3/library/constants.html#None"
        }
      ]
    },
    "description": "Returns the number of input tokens."
  },
  {
    "name": "cached_tokens",
    "type_info": {
      "type_str": "int | None",
      "description": null,
      "kind": "union",
      "base_type": {
        "type_str": "Union",
        "description": null,
        "kind": "simple",
        "doc_url": "https://docs.python.org/3/library/typing.html#typing.Union"
      },
      "parameters": [
        {
          "type_str": "int",
          "description": null,
          "kind": "simple",
          "doc_url": "https://docs.python.org/3/library/functions.html#int"
        },
        {
          "type_str": "None",
          "description": null,
          "kind": "simple",
          "doc_url": "https://docs.python.org/3/library/constants.html#None"
        }
      ]
    },
    "description": "Returns the number of cached tokens."
  },
  {
    "name": "output_tokens",
    "type_info": {
      "type_str": "int | None",
      "description": null,
      "kind": "union",
      "base_type": {
        "type_str": "Union",
        "description": null,
        "kind": "simple",
        "doc_url": "https://docs.python.org/3/library/typing.html#typing.Union"
      },
      "parameters": [
        {
          "type_str": "int",
          "description": null,
          "kind": "simple",
          "doc_url": "https://docs.python.org/3/library/functions.html#int"
        },
        {
          "type_str": "None",
          "description": null,
          "kind": "simple",
          "doc_url": "https://docs.python.org/3/library/constants.html#None"
        }
      ]
    },
    "description": "Returns the number of output tokens."
  },
  {
    "name": "cost_metadata",
    "type_info": {
      "type_str": "CostMetadata",
      "description": null,
      "kind": "simple",
      "doc_url": "/docs/v1/api/core/base/types#costmetadata"
    },
    "description": "Returns the cost metadata."
  },
  {
    "name": "common_finish_reasons",
    "type_info": {
      "type_str": "list[FinishReason] | None",
      "description": null,
      "kind": "union",
      "base_type": {
        "type_str": "Union",
        "description": null,
        "kind": "simple",
        "doc_url": "https://docs.python.org/3/library/typing.html#typing.Union"
      },
      "parameters": [
        {
          "type_str": "list[FinishReason]",
          "description": null,
          "kind": "generic",
          "base_type": {
            "type_str": "list",
            "description": null,
            "kind": "simple",
            "doc_url": "https://docs.python.org/3/library/stdtypes.html#list"
          },
          "parameters": [
            {
              "type_str": "FinishReason",
              "description": null,
              "kind": "simple",
              "doc_url": "/docs/v1/api/core/openai/call_response_chunk#finishreason"
            }
          ]
        },
        {
          "type_str": "None",
          "description": null,
          "kind": "simple",
          "doc_url": "https://docs.python.org/3/library/constants.html#None"
        }
      ]
    }
  }
]}
/>



