view release on metacpan or  search on metacpan

lib/DWIM/Block.pm  view on Meta::CPAN

=over

=item C<< Can't find API key >>

The module requires an OpenAI API key to allow it to connect with the AI server.
This key must be provided in an environment variable, which may be named
either C<DWIM_API_KEY> or C<OPENAI_API_KEY>.

You specified a C<DWIM> block, but it could not find either of those environment variables.

Set up the variable in your shell or IDE. For example, in your shell config file:

    # In your .bashrc or .zshrc file:
    export DWIM_API_KEY=sk-proj-y0ur0p3n41Pr0j3c74P1k3y6035H3r3TH150n35N07R34l

    # In your .cshrc file:
    setenv DWIM_API_KEY sk-proj-y0ur0p3n41Pr0j3c74P1k3y6035H3r3TH150n35N07R34l

    # In your .env file:
    DWIM_API_KEY=sk-proj-y0ur0p3n41Pr0j3c74P1k3y6035H3r3TH150n35N07R34l

=back


=head1 CONFIGURATION AND ENVIRONMENT

DWIM::Block requires no configuration files.

The module requires one of the following environment variables
to be set to a string representing a valid API key for the model
you are using:

    $ENV{'DWIM_API_KEY'}

    $ENV{'OPENAI_API_KEY'}

If both are set, then C<$ENV{'DWIM_API_KEY'}> is always used.

The module also looks for one of the following environment variables,
with which you can specify the specific model to be used:

    $ENV{'DWIM_MODEL'}

    $ENV{'OPENAI_MODEL'}

If both are set, then C<$ENV{'DWIM_MODEL'}> is always used.
If neither is set, then AI::Chat selects the model for you automatically.


=head1 DEPENDENCIES

This module requires the C<Filter::Simple>, C<PPR>, and C<AI::Chat> modules.


=head1 INCOMPATIBILITIES

None reported.


=head1 BUGS AND LIMITATIONS

No bugs have been reported.

What a C<DWIM> can be made to accomplish is limited primarily by your imagination.

Please report any bugs or feature requests to
C<bug-dwim-block@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.


=head1 AUTHOR

Damian Conway  C<< <DCONWAY@CPAN.org> >>


=head1 LICENCE AND COPYRIGHT

Copyright (c) 2024, Damian Conway C<< <DCONWAY@CPAN.org> >>. All rights reserved.

This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.


=head1 DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.