Class PdfChatGpt
Representa el plugin PdfChatGpt.
public sealed class PdfChatGpt : IDisposable
Herencia
Implementa
Miembros heredados
- object.GetType(),
- object.ToString(),
- object.Equals(object?),
- object.Equals(object?, object?),
- object.ReferenceEquals(object?, object?),
- object.GetHashCode()
Ejemplos
El ejemplo demuestra cómo usar el plugin PdfChatGpt agregando mensajes a la solicitud.
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Agregar la ruta del archivo de salida.
options.ApiKey = "Tu clave de API."; // Necesitas proporcionar la clave para acceder a la API.
options.MaxTokens = 1000; // El número máximo de tokens a generar en la finalización del chat.
// Agregar los mensajes de la solicitud.
options.Messages.Add(new Message
{
Content = "Eres un asistente útil.",
Role = Role.System
});
options.Messages.Add(new Message
{
Content = "¿Cuál es el diámetro de pizza más grande que se ha hecho?",
Role = Role.User
});
// Procesar la solicitud.
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // El objeto de finalización de chat de la API de ChatGPT.
}
El ejemplo demuestra cómo usar el plugin PdfChatGpt agregando un mensaje a la solicitud.
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Agregar la ruta del archivo de salida.
options.ApiKey = "Tu clave de API."; // Necesitas proporcionar la clave para acceder a la API.
options.MaxTokens = 1000; // El número máximo de tokens a generar en la finalización del chat.
// Agregar el mensaje de la solicitud.
// En este caso, el mensaje del sistema con Content = "Eres un asistente útil." se agrega por defecto.
// El rol del mensaje de consulta es "usuario" por defecto.
options.Query = "¿Cuál es la temperatura más baja registrada en la Tierra?";
// Procesar la solicitud.
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // El objeto de finalización de chat de la API de ChatGPT.
}
El ejemplo demuestra cómo usar el plugin PdfChatGpt agregando archivos como fuente(s) de mensaje.
using (var plugin = new PdfChatGpt())
{
var options = new PdfChatGptRequestOptions();
options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Agregar la ruta del archivo de salida.
// Agregar la fuente de texto PDF.
// En caso de múltiples fuentes, el texto de cada documento se agregará a la colección de mensajes de la solicitud
// como un mensaje separado con el rol "usuario".
options.AddInput(new FileDataSource("TextSource.pdf"));
options.ApiKey = "Tu clave de API."; // Necesitas proporcionar la clave para acceder a la API.
options.MaxTokens = 1000; // El número máximo de tokens a generar en la finalización del chat.
// Agregar el mensaje de la solicitud.
// En este caso, el mensaje del sistema con Content = "Eres un asistente útil." se agrega por defecto.
// El rol del mensaje de consulta es "usuario" por defecto.
options.Query = "¿Cuántas letras hay en el texto proporcionado?";
// Procesar la solicitud.
var result = await plugin.ProcessAsync(options);
var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // El objeto de finalización de chat de la API de ChatGPT.
}
Observaciones
El objeto Documentize.PdfChatGpt se utiliza para enviar solicitudes a ChatGPT directamente o agregando fuentes de archivo PDF y guardar la respuesta en la fuente de salida.
Constructores
PdfChatGpt()
Inicializa una nueva instancia del objeto Documentize.PdfChatGpt.
public PdfChatGpt()
Métodos
Dispose()
Implementación de IDisposable. De hecho, no es necesario para PdfChatGpt.
public void Dispose()
Process(IPluginOptions)
El método no tiene una versión sincrónica. Usa el método ProcessAsync en su lugar.
public ResultContainer Process(IPluginOptions options)
Parámetros
options
IPluginOptions: Un objeto de opciones que contiene instrucciones para el PdfChatGpt.
Retorna
ResultContainer : #### Excepciones
ProcessAsync(IPluginOptions)
Inicia el procesamiento de PdfChatGpt con los parámetros especificados.
public Task<resultcontainer> ProcessAsync(IPluginOptions options)
Parámetros
options
IPluginOptions: Un objeto de opciones que contiene instrucciones para el PdfChatGpt.
Retorna
El objeto de tarea que representa la operación asíncrona.
Excepciones
ArgumentException : InvalidOperationException
SetCancellationToken(CancellationToken)
Establece el token de cancelación.
public void SetCancellationToken(CancellationToken cancellationToken)
Parámetros
cancellationToken
CancellationToken: El token de cancelación. :
Namespace: Documentize Assembly: Documentize.dll