IChatClient Interfaz

Definición

Espacio de nombres:
Microsoft.Extensions.AI
Ensamblado:
Microsoft.Extensions.AI.Abstractions.dll
Paquete:
Microsoft.Extensions.AI.Abstractions v10.6.0
Source:
IChatClient.cs

Representa un cliente de chat.

public interface class IChatClient : IDisposable
public interface IChatClient : IDisposable
type IChatClient = interface
    interface IDisposable
Public Interface IChatClient
Implements IDisposable
Derivado
Implementaciones
IDisposable

Comentarios

Las aplicaciones deben tener en cuenta riesgos como ataques por inyección de mensajes, tamaños de datos y el número de mensajes enviados al proveedor subyacente o devueltos de él. A menos que una implementación específica IChatClient documente explícitamente medidas de seguridad para estos problemas, se espera que la aplicación implemente las protecciones adecuadas.

A menos que se especifique lo contrario, todos los miembros de IChatClient son seguros para subprocesos para uso simultáneo. Se espera que todas las implementaciones de IChatClient compatibilidad que usen varias solicitudes simultáneamente. Las instancias no deben eliminarse mientras la instancia todavía está en uso.

Sin embargo, las implementaciones de IChatClient pueden mutar los argumentos proporcionados a GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) y GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken), como mediante la configuración de la instancia de opciones. Por lo tanto, los consumidores de la interfaz deben evitar el uso de instancias compartidas de estos argumentos para invocaciones simultáneas o, de lo contrario, deben asegurarse de que no se use ninguna IChatClient instancia que pueda emplear dicha mutación. Por ejemplo, el método ConfigureOptions se proporciona con una devolución de llamada que podría mutar el argumento de opciones proporcionada y que se debe evitar si se usa una instancia de opciones singleton.

Métodos

Nombre Description
Dispose()

Realiza tareas definidas por la aplicación asociadas a la liberación, liberación o restablecimiento de recursos no administrados.

(Heredado de IDisposable)
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Envía mensajes de chat y devuelve la respuesta.
GetService(Type, Object)

Solicita un IChatClient objeto del tipo serviceTypeespecificado.
GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Envía mensajes de chat y transmite la respuesta.

Métodos de extensión

Nombre Description
AsBuilder(IChatClient)

Crea un nuevo ChatClientBuilder uso mediante innerClient como su cliente interno.
GetRequiredService(IChatClient, Type, Object)

Solicita un IChatClient objeto del tipo serviceType especificado y produce una excepción si no está disponible.
GetRequiredService<TService>(IChatClient, Object)

Pide al IChatClient objeto de tipo TService y produce una excepción si no está disponible.
GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Envía un mensaje de chat y devuelve los mensajes de respuesta.
GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Envía un mensaje de texto de chat de usuario y devuelve los mensajes de respuesta.
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)

Envía un mensaje de chat y solicita una respuesta que coincida con el tipo T.
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Envía un mensaje de chat y solicita una respuesta que coincida con el tipo T.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)

Envía mensajes de chat, solicitando una respuesta que coincida con el tipo T.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Envía mensajes de chat, solicitando una respuesta que coincida con el tipo T.
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)

Envía un mensaje de texto de chat de usuario, solicitando una respuesta que coincida con el tipo T.
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Envía un mensaje de texto de chat de usuario, solicitando una respuesta que coincida con el tipo T.
GetService<TService>(IChatClient, Object)

Pide al IChatClient objeto de tipo TService.
GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Envía un mensaje de chat y transmite los mensajes de respuesta.
GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Envía un mensaje de texto de chat de usuario y transmite los mensajes de respuesta.

Se aplica a

Consulte también