HealthResponseWrapper

Response wrapper for HealthResponse with metadata and validation. Extends ClientResponse to provide type-safe access to HealthResponse data along with HTTP response metadata.

Fields

Field	Type	Required	Default	Description
status_code	int	✓	PydanticUndefined	HTTP response status code
headers	ForwardRef('Dict[str, str]')	✗	PydanticUndefined	HTTP response headers
request_id	ForwardRef('Optional[str]')	✗	None	Unique request identifier for tracing
data	ForwardRef('HealthResponse')	✓	PydanticUndefined	Validated response data

Usage Example

from credoai.models import HealthResponseWrapper

# Create a new instance
model = HealthResponseWrapper(
    status_code=123,  # HTTP response status code
    data=None,  # Validated response data
)

# Convert to dictionary
model_dict = model.model_dump()
print(model_dict)

# Create from dictionary
data = {
    "status_code": 123,
    "data": None,
}
model_from_dict = HealthResponseWrapper(**data)

JSON Schema

{
  "type": "object",
  "title": "HealthResponseWrapper",
  "description": "Response wrapper for HealthResponse with metadata and validation.
Extends ClientResponse to provide type-safe access to HealthResponse data
along with HTTP response metadata.",
  "properties": {
    "status_code": {
      "type": "int",
      "description": "HTTP response status code"
    },
    "headers": {
      "type": "forwardref('dict[str, str]')",
      "description": "HTTP response headers"
    },
    "request_id": {
      "type": "forwardref('optional[str]')",
      "description": "Unique request identifier for tracing"
    },
    "data": {
      "type": "forwardref('healthresponse')",
      "description": "Validated response data"
    }
  },
  "required": ["status_code", "data"]
}