Class: PromptBuilder::Serializers::Base

Inherits:

Object

• Object
• PromptBuilder::Serializers::Base

Defined in:

lib/prompt_builder/serializers/base.rb

Overview

Base class for format serializers. Provides a common interface for exporting sessions and parsing responses in alternate API formats.

Direct Known Subclasses

ChatCompletion, ChatCompletion::Request, ChatCompletion::Response, Converse, Converse::Request, Converse::Response, Gemini, Gemini::Request, Gemini::Response, Messages, Messages::Request, Messages::Response, OpenResponses, OpenResponses::Request, OpenResponses::Response

Class Method Summary

• .parse_response(hash, headers: nil) ⇒ Response

  Parse a response from the target format into an PromptBuilder::Response.

• .request_payload(session) ⇒ Hash

  Export a session to the target format's request payload.

Class Method Details

.parse_response(hash, headers: nil) ⇒ Response

Parse a response from the target format into an PromptBuilder::Response. Format classes that define a nested Response parser delegate to it.

Parameters:

• hash (Hash) —

  the response hash in the target format

• headers (Hash, #each, nil) (defaults to: nil) —

  the HTTP response headers, for formats that return response metadata in headers rather than in the body

Returns:

• (Response) —

  the parsed response

Raises:

• (ErrorResponseError) —

  if the payload is an API error envelope

# File 'lib/prompt_builder/serializers/base.rb', line 26

def parse_response(hash, headers: nil)
  if const_defined?(:Response, false)
    return const_get(:Response, false).parse_response(hash, headers: headers)
  end

  check_error_response!(hash)
  deserialize_response(hash)
end

.request_payload(session) ⇒ Hash

Export a session to the target format's request payload.

Parameters:

• session (Session) —

  the session to export

Returns:

• (Hash) —

  the serialized request payload

# File 'lib/prompt_builder/serializers/base.rb', line 13

def request_payload(session)
  serialize_request(session)
end