chore: add missing docstrings

Author: stainless-app[bot]

src/openai/types/audio/transcription.py

@@ -21,6 +21,8 @@ class Logprob(BaseModel):
 
 
 class UsageTokensInputTokenDetails(BaseModel):
+    """Details about the input tokens billed for this request."""
+
     audio_tokens: Optional[int] = None
     """Number of audio tokens billed for this request."""
 
@@ -29,6 +31,8 @@ class UsageTokensInputTokenDetails(BaseModel):
 
 
 class UsageTokens(BaseModel):
+    """Usage statistics for models billed by token usage."""
+
     input_tokens: int
     """Number of input tokens billed for this request."""
 
@@ -46,6 +50,8 @@ class UsageTokens(BaseModel):
 
 
 class UsageDuration(BaseModel):
+    """Usage statistics for models billed by audio input duration."""
+
     seconds: float
     """Duration of the input audio in seconds."""
 
@@ -57,6 +63,10 @@ class UsageDuration(BaseModel):
 
 
 class Transcription(BaseModel):
+    """
+    Represents a transcription response returned by model, based on the provided input.
+    """
+
     text: str
     """The transcribed text."""
 

src/openai/types/audio/transcription_diarized.py

@@ -11,6 +11,8 @@
 
 
 class UsageTokensInputTokenDetails(BaseModel):
+    """Details about the input tokens billed for this request."""
+
     audio_tokens: Optional[int] = None
     """Number of audio tokens billed for this request."""
 
@@ -19,6 +21,8 @@ class UsageTokensInputTokenDetails(BaseModel):
 
 
 class UsageTokens(BaseModel):
+    """Usage statistics for models billed by token usage."""
+
     input_tokens: int
     """Number of input tokens billed for this request."""
 
@@ -36,6 +40,8 @@ class UsageTokens(BaseModel):
 
 
 class UsageDuration(BaseModel):
+    """Usage statistics for models billed by audio input duration."""
+
     seconds: float
     """Duration of the input audio in seconds."""
 
@@ -47,6 +53,10 @@ class UsageDuration(BaseModel):
 
 
 class TranscriptionDiarized(BaseModel):
+    """
+    Represents a diarized transcription response returned by the model, including the combined transcript and speaker-segment annotations.
+    """
+
     duration: float
     """Duration of the input audio in seconds."""
 

src/openai/types/audio/transcription_diarized_segment.py

@@ -8,6 +8,8 @@
 
 
 class TranscriptionDiarizedSegment(BaseModel):
+    """A segment of diarized transcript text with speaker metadata."""
+
     id: str
     """Unique identifier for the segment."""
 

src/openai/types/audio/transcription_text_delta_event.py

@@ -20,6 +20,11 @@ class Logprob(BaseModel):
 
 
 class TranscriptionTextDeltaEvent(BaseModel):
+    """Emitted when there is an additional text delta.
+
+    This is also the first event emitted when the transcription starts. Only emitted when you [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.
+    """
+
     delta: str
     """The text delta that was additionally transcribed."""
 

src/openai/types/audio/transcription_text_done_event.py

@@ -20,6 +20,8 @@ class Logprob(BaseModel):
 
 
 class UsageInputTokenDetails(BaseModel):
+    """Details about the input tokens billed for this request."""
+
     audio_tokens: Optional[int] = None
     """Number of audio tokens billed for this request."""
 
@@ -28,6 +30,8 @@ class UsageInputTokenDetails(BaseModel):
 
 
 class Usage(BaseModel):
+    """Usage statistics for models billed by token usage."""
+
     input_tokens: int
     """Number of input tokens billed for this request."""
 
@@ -45,6 +49,11 @@ class Usage(BaseModel):
 
 
 class TranscriptionTextDoneEvent(BaseModel):
+    """Emitted when the transcription is complete.
+
+    Contains the complete transcription text. Only emitted when you [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.
+    """
+
     text: str
     """The text that was transcribed."""
 

src/openai/types/audio/transcription_text_segment_event.py

@@ -8,6 +8,10 @@
 
 
 class TranscriptionTextSegmentEvent(BaseModel):
+    """
+    Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription) with `stream` set to `true` and `response_format` set to `diarized_json`.
+    """
+
     id: str
     """Unique identifier for the segment."""
 

src/openai/types/audio/transcription_verbose.py

@@ -11,6 +11,8 @@
 
 
 class Usage(BaseModel):
+    """Usage statistics for models billed by audio input duration."""
+
     seconds: float
     """Duration of the input audio in seconds."""
 
@@ -19,6 +21,10 @@ class Usage(BaseModel):
 
 
 class TranscriptionVerbose(BaseModel):
+    """
+    Represents a verbose json transcription response returned by model, based on the provided input.
+    """
+
     duration: float
     """The duration of the input audio."""
 

src/openai/types/auto_file_chunking_strategy_param.py

@@ -8,5 +8,10 @@
 
 
 class AutoFileChunkingStrategyParam(TypedDict, total=False):
+    """The default strategy.
+
+    This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.
+    """
+
     type: Required[Literal["auto"]]
     """Always `auto`."""

src/openai/types/batch_create_params.py

@@ -58,6 +58,10 @@ class BatchCreateParams(TypedDict, total=False):
 
 
 class OutputExpiresAfter(TypedDict, total=False):
+    """
+    The expiration policy for the output and/or error file that are generated for a batch.
+    """
+
     anchor: Required[Literal["created_at"]]
     """Anchor timestamp after which the expiration policy applies.
 

src/openai/types/batch_request_counts.py

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