Класс PdfChatGpt

Информация

Представляет плагин PdfChatGpt.

public sealed class PdfChatGpt : IDisposable

Наследование

object ← PdfChatGpt

Реализует

Унаследованные члены

Примеры

Пример демонстрирует, как использовать плагин PdfChatGpt, добавляя сообщения в запрос.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Добавьте путь к выходному файлу.
    options.ApiKey = "Ваш API ключ."; // Вам нужно предоставить ключ для доступа к API.
    options.MaxTokens = 1000; // Максимальное количество токенов для генерации в завершении беседы.

    // Добавьте сообщения запроса.
    options.Messages.Add(new Message
    {
        Content = "Вы полезный помощник.",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "Какой самый большой диаметр пиццы, когда-либо сделанной?",
        Role = Role.User
    });

    // Обработать запрос.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Объект завершения беседы API ChatGPT.
}

Пример демонстрирует, как использовать плагин PdfChatGpt, добавляя одно сообщение в запрос.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Добавьте путь к выходному файлу.
    options.ApiKey = "Ваш API ключ."; // Вам нужно предоставить ключ для доступа к API.
    options.MaxTokens = 1000; // Максимальное количество токенов для генерации в завершении беседы.

    // Добавьте сообщение запроса.
    // В этом случае системное сообщение с Content = "Вы полезный помощник." добавляется по умолчанию.
    // Роль сообщения запроса по умолчанию "пользователь".
    options.Query = "Какова самая низкая температура, зарегистрированная на Земле?";

    // Обработать запрос.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Объект завершения беседы API ChatGPT.
}

Пример демонстрирует, как использовать плагин PdfChatGpt, добавляя файлы в качестве источников сообщений.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Добавьте путь к выходному файлу.

    // Добавьте текстовый источник PDF.
    // В случае нескольких источников текст из каждого документа будет добавлен в коллекцию сообщений запроса
    // в качестве отдельного сообщения с ролью "пользователь".
    options.AddInput(new FileDataSource("TextSource.pdf"));

    options.ApiKey = "Ваш API ключ."; // Вам нужно предоставить ключ для доступа к API.
    options.MaxTokens = 1000; // Максимальное количество токенов для генерации в завершении беседы.

    // Добавьте сообщение запроса.
    // В этом случае системное сообщение с Content = "Вы полезный помощник." добавляется по умолчанию.
    // Роль сообщения запроса по умолчанию "пользователь".
    options.Query = "Сколько букв в предоставленном тексте?";

    // Обработать запрос.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Объект завершения беседы API ChatGPT.
}

Заметки

Объект Documentize.PdfChatGpt используется для отправки запросов к ChatGPT напрямую или с добавлением источников PDF-файлов и сохранения ответа в выходном источнике.

Конструкторы

PdfChatGpt()

Инициализирует новый экземпляр объекта Documentize.PdfChatGpt.

public PdfChatGpt()

Методы

Dispose()

Реализация IDisposable. На самом деле, это не обязательно для PdfChatGpt.

public void Dispose()

Process(IPluginOptions)

У этого метода нет синхронной версии. Вместо этого используйте метод ProcessAsync.

public ResultContainer Process(IPluginOptions options)

Параметры

  • options IPluginOptions: Объект параметров, содержащий инструкции для PdfChatGpt.

Возвращает

ResultContainer : #### Исключения

NotImplementedException

ProcessAsync(IPluginOptions)

Запускает обработку PdfChatGpt с указанными параметрами.

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

Параметры

  • options IPluginOptions: Объект параметров, содержащий инструкции для PdfChatGpt.

Возвращает

Task<ResultContainer&gt;

Объект задачи, представляющий асинхронную операцию.

Исключения

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

Устанавливает токен отмены.

public void SetCancellationToken(CancellationToken cancellationToken)

Параметры

Пространство имен: Documentize Сборка: Documentize.dll

 Русский