Class ChatGptRequestOptions
Представляет параметры плагина Documentize.PdfManager.
public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptionsНаследование
object ← PluginBaseOptions ← ChatGptRequestOptions
Реализует
Унаследованные члены
- PluginBaseOptions.AddInput(IData),
- PluginBaseOptions.AddOutput(IData),
- PluginBaseOptions.Inputs,
- PluginBaseOptions.Outputs,
- PluginBaseOptions.CloseInputStreams,
- PluginBaseOptions.CloseOutputStreams,
- object.GetType(),
- object.MemberwiseClone(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Конструкторы
ChatGptRequestOptions()
Инициализирует новый экземпляр объекта Documentize.ChatGptRequestOptions с настройками по умолчанию.
public ChatGptRequestOptions()ChatGptRequestOptions(string, string, string, string)
Инициализирует новый экземпляр объекта Documentize.ChatGptRequestOptions с указанными параметрами.
public ChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)Параметры
apiKeystring: Ключ доступа к API ChatGPT.modelstring: Имя модели ChatGPT. Модель по умолчанию: gpt-3.5-turbo-1106.apiUrlstring: URL API ChatGPT. URL по умолчанию: https://api.openai.com/v1/chat/completions.querystring: Строковый запрос к ChatGPT.
Свойства
ApiKey
Получает или устанавливает ключ доступа к API ChatGPT.
public string ApiKey { get; set; }Тип свойства
ApiUrl
Получает или устанавливает URL API ChatGPT.
public string ApiUrl { get; set; }Тип свойства
CancellationToken
Токен отмены.
public CancellationToken CancellationToken { get; set; }Тип свойства
MaxTokens
Максимальное количество токенов в ответе.
Значение по умолчанию — null, что означает отсутствие ограничения.
public int? MaxTokens { get; set; }Тип свойства
int?
Messages
Получает или задаёт коллекцию объектов Documentize.Message.
public List<message> Messages { get; set; }Тип свойства
Примечание
При добавлении нескольких сообщений в параметры порядок в коллекции сообщений такой:
- Первое сообщение (если есть) берётся из
options.Query, перед ним добавляется сообщение с содержимым: «You are a helpful assistant.» и ролью «system». - Затем (если есть) добавляются сообщения из коллекции
options.Messages. - Сообщения из файловых источников (если есть) добавляются последними, по одному объекту сообщения для каждого документа с ролью «user».
Если не предоставлено ни одного сообщения, выбрасываетсяArgumentException.
Model
Устанавливает или получает идентификатор модели, которая будет использоваться.
public string Model { get; set; }Тип свойства
NumberOfChoices
Количество вариантов завершения чата, генерируемых для каждого входного сообщения.
public int NumberOfChoices { get; set; }Тип свойства
Query
Получает или задаёт строковый запрос к ChatGPT.
Если не пустой, он будет первым сообщением в коллекции, которое отправляется в запросе.
public string Query { get; set; }Тип свойства
Temperature
Температура сэмплинга, значение от 0 до 2.
Более высокие значения (например, 0.8) делают вывод более случайным, а более низкие (например, 0.2) — более сфокусированным и детерминированным. Значение по умолчанию — 1.
public double Temperature { get; set; }Тип свойства
Namespace: Documentize
Assembly: Documentize.dll