Class BatchRequest

scrapegraphai/utils/batch_api.py:29–67

A single request within a batch submission.

@dataclass
class BatchRequest:
    """A single request within a batch submission."""

    custom_id: str
    """Unique identifier for mapping responses back to requests."""

    model: str
    """The OpenAI model to use (e.g., 'gpt-4o-mini')."""

    messages: List[Dict[str, str]]
    """The chat messages for this request."""

    temperature: float = 0.0
    """Sampling temperature."""

    max_tokens: Optional[int] = None
    """Maximum tokens in the response."""

    response_format: Optional[Dict[str, str]] = None
    """Optional response format (e.g., {"type": "json_object"})."""

    def to_jsonl_line(self) -> str:
        """Convert to a JSONL line for the Batch API input file."""
        body = {
            "model": self.model,
            "messages": self.messages,
            "temperature": self.temperature,
        }
        if self.max_tokens is not None:
            body["max_tokens"] = self.max_tokens
        if self.response_format is not None:
            body["response_format"] = self.response_format

        return json.dumps({
            "custom_id": self.custom_id,
            "method": "POST",
            "url": "/v1/chat/completions",
            "body": body,
        })


@dataclass