Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

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

object ←
PluginBaseOptions ←
ChatGptRequestOptions

Реализует

• IPluginOptions

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

• 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)

Параметры

• apiKey string: Ключ доступа к API ChatGPT.
• model string: Название модели ChatGPT. Модель по умолчанию: gpt-3.5-turbo-1106.
• apiUrl string: URL API ChatGPT. URL по умолчанию: https://api.openai.com/v1/chat/completions.
• query string: Строковый запрос к ChatGPT.

Свойства

ApiKey

Получает или задаёт ключ доступа к API ChatGPT.

public string ApiKey { get; set; }

Тип свойства

string

ApiUrl

Получает или задаёт URL API ChatGPT.

public string ApiUrl { get; set; }

Тип свойства

string

CancellationToken

Токен отмены.

public CancellationToken CancellationToken { get; set; }

Тип свойства

CancellationToken

MaxTokens

Максимальное количество токенов в ответе. Значение по умолчанию — null, что означает бесконечность.

public int? MaxTokens { get; set; }

Тип свойства

int?

Messages

Получает или задаёт коллекцию объектов Documentize.Message.

public List<message> Messages { get; set; }

Тип свойства

List<Message>

Примечание

При добавлении нескольких сообщений в параметры порядок в коллекции сообщений следующий:

• Первое сообщение (если оно есть) берётся из options.Query, перед ним добавляется сообщение с содержимым «You are a helpful assistant.» и ролью «system».
• Затем (если есть) добавляются сообщения из коллекции options.Messages.
• Сообщения из файлов‑источников (если есть) добавляются последними, по одному объекту сообщения для каждого документа с ролью «user».
  Если ни одно сообщение не предоставлено, генерируется ArgumentException.

Model

Задаёт или получает идентификатор модели, которую следует использовать.

public string Model { get; set; }

Тип свойства

string

NumberOfChoices

Сколько вариантов завершения чата генерировать для каждого входного сообщения.

public int NumberOfChoices { get; set; }

Тип свойства

int

Query

Получает или задаёт строковый запрос к ChatGPT. Если не пустой, это первое сообщение в коллекции, которое будет отправлено в запросе.

public string Query { get; set; }

Тип свойства

string

Temperature

Температура сэмплирования, значение от 0 до 2. Более высокие значения (например, 0.8) делают вывод более случайным, а более низкие (например, 0.2) делают его более сфокусированным и детерминированным. Значение по умолчанию — 1.

public double Temperature { get; set; }

Тип свойства

double