nextcloud-server/lib/public/LanguageModel/ILanguageModelProvider.php

50 lines
1.4 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Marcel Klehr <mklehr@gmx.net>
*
* @author Marcel Klehr <mklehr@gmx.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\LanguageModel;
use RuntimeException;
/**
* This is the minimum interface is implemented by apps that
* implement a LanguageModel provider
* @since 28.0.0
*/
interface ILanguageModelProvider {
/**
* @since 28.0.0
*/
public function getName(): string;
/**
* @param string $prompt The prompt to call the model with
* @return string the output
* @since 28.0.0
* @throws RuntimeException If the text could not be transcribed
*/
public function prompt(string $prompt): string;
}