Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ChatGptRequestOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

ChatGptRequestOptions()

Initialise une nouvelle instance de l’objet Documentize.ChatGptRequestOptions avec les options par défaut.

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

Initialise une nouvelle instance de l’objet Documentize.ChatGptRequestOptions avec des options.

public ChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)

Parameters

• apiKey string : La clé d’accès à l’API ChatGPT.
• model string : Le nom du modèle ChatGPT. Le modèle par défaut est : gpt-3.5-turbo-1106.
• apiUrl string : L’URL de l’API ChatGPT. L’URL par défaut est : https://api.openai.com/v1/chat/completions.
• query string : La requête sous forme de chaîne envoyée à ChatGPT.

Properties

ApiKey

Obtient ou définit la clé d’accès à l’API ChatGPT.

public string ApiKey { get; set; }

Property Value

string

ApiUrl

Obtient ou définit l’URL de l’API ChatGPT.

public string ApiUrl { get; set; }

Property Value

string

CancellationToken

Le jeton d’annulation.

public CancellationToken CancellationToken { get; set; }

Property Value

CancellationToken

MaxTokens

Nombre maximum de jetons dans la réponse.
La valeur par défaut est null, ce qui signifie illimité.

public int? MaxTokens { get; set; }

Property Value

int?

Messages

Obtient ou définit une collection d’objets Documentize.Message.

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

Property Value

List<Message>

Remarks

Lors de l’ajout de plusieurs messages aux options, l’ordre dans la collection est le suivant :

• Le premier message (le cas échéant) provient de options.Query, précédé du message contenant le texte : « You are a helpful assistant. », et le rôle est « system ».
• Ensuite (le cas échéant) les messages de la collection options.Messages sont ajoutés.
• Les messages provenant de sources de fichiers (le cas échéant) sont ajoutés en dernier, un objet message par document avec le rôle « user ». Si aucun message n’est fourni, une ArgumentException est levée.

Model

Définit ou obtient l’ID du modèle à utiliser.

public string Model { get; set; }

Property Value

string

NumberOfChoices

Nombre de choix de complétion de chat à générer pour chaque message d’entrée.

public int NumberOfChoices { get; set; }

Property Value

int

Query

Obtient ou définit la requête sous forme de chaîne envoyée à ChatGPT.
Si elle n’est pas vide, c’est le premier message de la collection qui sera envoyé dans la requête.

public string Query { get; set; }

Property Value

string

Temperature

Température d’échantillonnage utilisée, entre 0 et 2.
Des valeurs plus élevées comme 0,8 rendront la sortie plus aléatoire, tandis que des valeurs plus faibles comme 0,2 la rendront plus ciblée et déterministe.
La valeur par défaut est 1.

public double Temperature { get; set; }

Property Value

double