chore: add missing docstrings

Author: stainless-app[bot]

src/groq/types/audio/transcription.py

@@ -6,5 +6,9 @@
 
 
 class Transcription(BaseModel):
+    """
+    Represents a transcription response returned by model, based on the provided input.
+    """
+
     text: str
     """The transcribed text."""

src/groq/types/batch_cancel_response.py

@@ -31,6 +31,8 @@ class Errors(BaseModel):
 
 
 class RequestCounts(BaseModel):
+    """The request counts for different statuses within the batch."""
+
     completed: int
     """Number of requests that have been completed successfully."""
 

src/groq/types/batch_create_response.py

@@ -31,6 +31,8 @@ class Errors(BaseModel):
 
 
 class RequestCounts(BaseModel):
+    """The request counts for different statuses within the batch."""
+
     completed: int
     """Number of requests that have been completed successfully."""
 

src/groq/types/batch_list_response.py

@@ -31,6 +31,8 @@ class DataErrors(BaseModel):
 
 
 class DataRequestCounts(BaseModel):
+    """The request counts for different statuses within the batch."""
+
     completed: int
     """Number of requests that have been completed successfully."""
 

src/groq/types/batch_retrieve_response.py

@@ -31,6 +31,8 @@ class Errors(BaseModel):
 
 
 class RequestCounts(BaseModel):
+    """The request counts for different statuses within the batch."""
+
     completed: int
     """Number of requests that have been completed successfully."""
 

src/groq/types/chat/chat_completion.py

@@ -23,6 +23,8 @@
 
 
 class ChoiceLogprobs(BaseModel):
+    """Log probability information for the choice."""
+
     content: Optional[List[ChatCompletionTokenLogprob]] = None
     """A list of message content tokens with log probability information."""
 
@@ -84,11 +86,20 @@ class UsageBreakdownModel(BaseModel):
 
 
 class UsageBreakdown(BaseModel):
+    """
+    Detailed usage breakdown by model when multiple models are used in the request for compound AI systems.
+    """
+
     models: List[UsageBreakdownModel]
     """List of models used in the request and their individual usage statistics"""
 
 
 class XGroqDebug(BaseModel):
+    """Debug information including input and output token IDs and strings.
+
+    Only present when debug=true in the request.
+    """
+
     input_token_ids: Optional[List[int]] = None
     """Token IDs for the input."""
 
@@ -103,6 +114,8 @@ class XGroqDebug(BaseModel):
 
 
 class XGroqUsage(BaseModel):
+    """Additional Groq-specific usage metrics (hardware cache statistics)."""
+
     dram_cached_tokens: Optional[int] = None
     """Number of tokens served from DRAM cache."""
 
@@ -111,6 +124,8 @@ class XGroqUsage(BaseModel):
 
 
 class XGroq(BaseModel):
+    """Groq-specific metadata for non-streaming chat completion responses."""
+
     id: str
     """
     A groq request ID which can be used to refer to a specific request to groq
@@ -134,6 +149,10 @@ class XGroq(BaseModel):
 
 
 class ChatCompletion(BaseModel):
+    """
+    Represents a chat completion response returned by model, based on the provided input.
+    """
+
     id: str
     """A unique identifier for the chat completion."""
 

src/groq/types/chat/chat_completion_assistant_message_param.py

@@ -12,6 +12,11 @@
 
 
 class FunctionCall(TypedDict, total=False):
+    """Deprecated and replaced by `tool_calls`.
+
+    The name and arguments of a function that should be called, as generated by the model.
+    """
+
     arguments: str
     """
     The arguments to call the function with, as generated by the model in JSON

src/groq/types/chat/chat_completion_function_call_option_param.py

@@ -8,5 +8,9 @@
 
 
 class ChatCompletionFunctionCallOptionParam(TypedDict, total=False):
+    """
+    Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.
+    """
+
     name: Required[str]
     """The name of the function to call."""

src/groq/types/chat/chat_completion_message.py

@@ -23,6 +23,8 @@
 
 
 class AnnotationDocumentCitation(BaseModel):
+    """A citation referencing a specific document that was provided in the request."""
+
     document_id: str
     """
     The ID of the document being cited, corresponding to a document provided in the
@@ -37,6 +39,8 @@ class AnnotationDocumentCitation(BaseModel):
 
 
 class AnnotationFunctionCitation(BaseModel):
+    """A citation referencing the result of a function or tool call."""
+
     end_index: int
     """The character index in the message content where this citation ends."""
 
@@ -51,6 +55,8 @@ class AnnotationFunctionCitation(BaseModel):
 
 
 class Annotation(BaseModel):
+    """An annotation that provides citations or references for content in a message."""
+
     type: Literal["document_citation", "function_citation"]
     """The type of annotation."""
 
@@ -181,6 +187,8 @@ class ExecutedToolSearchResultsResult(BaseModel):
 
 
 class ExecutedToolSearchResults(BaseModel):
+    """The search results returned by the tool, if applicable."""
+
     images: Optional[List[str]] = None
     """List of image URLs returned by the search"""
 
@@ -212,6 +220,11 @@ class ExecutedTool(BaseModel):
 
 
 class FunctionCall(BaseModel):
+    """Deprecated and replaced by `tool_calls`.
+
+    The name and arguments of a function that should be called, as generated by the model.
+    """
+
     arguments: str
     """
     The arguments to call the function with, as generated by the model in JSON
@@ -225,6 +238,8 @@ class FunctionCall(BaseModel):
 
 
 class ChatCompletionMessage(BaseModel):
+    """A chat completion message generated by the model."""
+
     content: Optional[str] = None
     """The contents of the message."""
 

src/groq/types/chat/chat_completion_message_tool_call.py

@@ -8,6 +8,8 @@
 
 
 class Function(BaseModel):
+    """The function that the model called."""
+
     arguments: str
     """
     The arguments to call the function with, as generated by the model in JSON