The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

NFERRAZ / OpenAI-API-0.37 / lib / OpenAI / API / Error.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
—
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

              
package OpenAI::API::Error;
use Moo;
use strictures 2;
use namespace::clean;
extends 'Throwable::Error';
has request => (
    is  => 'ro',
    isa => sub { ref $_[0] eq 'HTTP::Request' or die "expected HTTP::Request object" },
);
has response => (
    is  => 'ro',
    isa => sub { ref $_[0] eq 'HTTP::Response' or die "expected HTTP::Response object" },
);
1;
__END__
=head1 NAME
OpenAI::API::Error - throwable error objects
=head1 SYNOPSIS
    use OpenAI::API::Error;
    OpenAI::API::Error->throw(
        message  => 'Something went wrong',
        request  => $req,
        response => $res,
    );
    # elsewhere...
    try {
        my $response = $openai->$method(...);
    } catch ($e) {
        # Handle error
    }
=head1 DESCRIPTION
The C<OpenAI::API::Error> module provides an object-oriented exception
mechanism for errors encountered while interacting with the OpenAI
API. It extends the L<Throwable::Error> class to include the optional
L<HTTP::Request> and L<HTTP::Response> objects, allowing for better
error reporting and debugging.
=head1 ATTRIBUTES
=head2 request
The C<request> attribute holds the L<HTTP::Request> object associated
with the error.
=head2 response
The C<response> attribute holds the L<HTTP::Response> object associated
with the error.
=head1 METHODS
=head2 throw
The C<throw> method creates a new OpenAI::API::Error object with the
provided message, request, and response attributes and throws it as
an exception.
=head1 SEE ALSO
=over 4
=item *
L<Throwable::Error>
=item *
L<HTTP::Request>
=item *
L<HTTP::Response>
=back