SDK de C#
Instala y configura el SDK de C# de Anthropic para aplicaciones .NET con integración de IChatClient
El SDK de C# de Anthropic proporciona un acceso conveniente a la Claude API desde aplicaciones escritas en C#.
Instalación
Instala el paquete desde NuGet:
dotnet add package AnthropicRequisitos
Esta biblioteca requiere .NET Standard 2.0 o posterior.
Uso
using System;
using Anthropic;
using Anthropic.Models.Messages;
AnthropicClient client = new();
MessageCreateParams parameters = new()
{
MaxTokens = 1024,
Messages =
[
new()
{
Role = Role.User,
Content = "Hello, Claude",
},
],
Model = Model.ClaudeOpus5,
};
var message = await client.Messages.Create(parameters);
foreach (var block in message.Content)
{
if (block.TryPickText(out var textBlock))
{
Console.WriteLine(textBlock.Text);
}
}Para conocer las opciones de autenticación, incluida Workload Identity Federation, consulta Autenticación. Si tu clave de API es una clave personal o de cuenta de servicio con acceso a múltiples espacios de trabajo, establece el ID del espacio de trabajo en el encabezado de solicitud anthropic-workspace-id; Seleccionar un espacio de trabajo muestra la opción por solicitud para este SDK.
Configuración del cliente
Configura el cliente usando variables de entorno:
using Anthropic;
// Configurado mediante las variables de entorno ANTHROPIC_API_KEY, ANTHROPIC_AUTH_TOKEN y ANTHROPIC_BASE_URL
AnthropicClient client = new();O manualmente:
using Anthropic;
AnthropicClient client = new() { ApiKey = "my-anthropic-api-key" };O usando una combinación de ambos enfoques.
Consulta esta tabla para ver las opciones disponibles:
| Propiedad | Variable de entorno | Requerida | Valor predeterminado |
|---|---|---|---|
ApiKey | ANTHROPIC_API_KEY | false | - |
AuthToken | ANTHROPIC_AUTH_TOKEN | false | - |
BaseUrl | ANTHROPIC_BASE_URL | true | "https://api.anthropic.com" |
Modificar la configuración
Para usar temporalmente una configuración de cliente modificada, reutilizando la misma conexión y los mismos grupos de hilos, llama a WithOptions en cualquier cliente o servicio:
using System;
var message = await client
.WithOptions(options =>
options with
{
BaseUrl = "https://example.com",
Timeout = TimeSpan.FromSeconds(42),
}
)
.Messages.Create(parameters);
Console.WriteLine(message);Usar una expresión with facilita la construcción de las opciones modificadas.
El método WithOptions no afecta al cliente o servicio original.
Streaming
El SDK define métodos que devuelven flujos de "chunks" (fragmentos) de respuesta, donde cada fragmento puede procesarse individualmente tan pronto como llega, en lugar de esperar la respuesta completa. Los métodos de streaming generalmente corresponden a respuestas SSE o JSONL.
Un método de streaming siempre tiene el sufijo Streaming en su nombre, incluso si no tiene una variante sin streaming.
Estos métodos de streaming devuelven IAsyncEnumerable:
using System;
using Anthropic.Models.Messages;
MessageCreateParams parameters = new()
{
MaxTokens = 1024,
Messages =
[
new()
{
Role = Role.User,
Content = "Hello, Claude",
},
],
Model = Model.ClaudeOpus5,
};
await foreach (var message in client.Messages.CreateStreaming(parameters))
{
Console.WriteLine(message);
}Manejo de errores
El SDK lanza tipos de excepciones personalizadas no comprobadas:
AnthropicApiException: Clase base para errores de la API. Consulta esta tabla para ver qué subclase de excepción se lanza para cada código de estado HTTP:
| Estado | Excepción |
|---|---|
| 400 | AnthropicBadRequestException |
| 401 | AnthropicUnauthorizedException |
| 403 | AnthropicForbiddenException |
| 404 | AnthropicNotFoundException |
| 422 | AnthropicUnprocessableEntityException |
| 429 | AnthropicRateLimitException |
| 5xx | Anthropic5xxException |
| otros | AnthropicUnexpectedStatusCodeException |
Además, todos los errores 4xx heredan de Anthropic4xxException.
-
AnthropicSseException: se lanza para errores encontrados durante el streaming SSE después de una respuesta HTTP inicial exitosa. -
AnthropicIOException: Errores de red de E/S. -
AnthropicInvalidDataException: Fallo al interpretar datos analizados correctamente. Por ejemplo, al acceder a una propiedad que se supone que es obligatoria, pero que la API omitió inesperadamente de la respuesta. -
AnthropicException: Clase base para todas las excepciones.
Reintentos
El SDK reintenta automáticamente 2 veces de forma predeterminada, con un breve retroceso exponencial entre solicitudes.
Solo se reintentan los siguientes tipos de errores:
- Errores de conexión (por ejemplo, debido a un problema de conectividad de red)
- 408 Request Timeout
- 409 Conflict
- 429 Rate Limit (límite de velocidad)
- 5xx Internal
La API también puede indicar explícitamente al SDK que reintente o no reintente una solicitud.
Para establecer un número personalizado de reintentos, configura el cliente usando la propiedad MaxRetries:
using Anthropic;
AnthropicClient client = new() { MaxRetries = 3 };O configura una única llamada a un método usando WithOptions:
using System;
var message = await client
.WithOptions(options =>
options with { MaxRetries = 3 }
)
.Messages.Create(parameters);
Console.WriteLine(message);Tiempos de espera
Las solicitudes agotan su tiempo de espera después de 10 minutos de forma predeterminada.
Para establecer un tiempo de espera personalizado, configura el cliente usando la opción Timeout:
using System;
using Anthropic;
AnthropicClient client = new() { Timeout = TimeSpan.FromSeconds(42) };O configura una única llamada a un método usando WithOptions:
using System;
var message = await client
.WithOptions(options =>
options with { Timeout = TimeSpan.FromSeconds(42) }
)
.Messages.Create(parameters);
Console.WriteLine(message);Paginación
El SDK define métodos que devuelven listas paginadas de resultados. Proporciona formas convenientes de acceder a los resultados, ya sea una página a la vez o elemento por elemento a través de todas las páginas.
Paginación automática
Para iterar por todos los resultados de todas las páginas, usa el método Paginate, que obtiene automáticamente más páginas según sea necesario. El método devuelve un IAsyncEnumerable:
using System;
var page = await client.Messages.Batches.List(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}Paginación manual
Para acceder a los elementos de una página individual y solicitar manualmente la página siguiente, usa la propiedad Items y los métodos HasNext y Next:
var page = await client.Messages.Batches.List();
while (true)
{
foreach (var item in page.Items)
{
Console.WriteLine(item);
}
if (!page.HasNext())
{
break;
}
page = await page.Next();
}Validación de respuestas
En casos poco frecuentes, la API puede devolver una respuesta que no coincide con el tipo esperado. De forma predeterminada, el SDK no lanza una excepción en este caso. Lanza AnthropicInvalidDataException solo si accedes directamente a la propiedad.
Si prefieres comprobar de antemano que la respuesta está completamente bien tipada, llama a Validate:
var message = await client.Messages.Create(parameters);
message.Validate();O configura el cliente usando la opción ResponseValidation:
using Anthropic;
AnthropicClient client = new() { ResponseValidation = true };O configura una única llamada a un método usando WithOptions:
using System;
var message = await client
.WithOptions(options =>
options with { ResponseValidation = true }
)
.Messages.Create(parameters);
Console.WriteLine(message);Integración con IChatClient
El SDK proporciona una implementación de la interfaz IChatClient de la biblioteca Microsoft.Extensions.AI.Abstractions. Esto permite que AnthropicClient (y Anthropic.Services.IBetaService) se use con otras bibliotecas que se integran con estas abstracciones principales. Por ejemplo, las herramientas de la biblioteca del SDK de C# de MCP (ModelContextProtocol) pueden usarse directamente con un AnthropicClient expuesto a través de IChatClient.
using Anthropic;
using Microsoft.Extensions.AI;
using ModelContextProtocol.Client;
// Configurado mediante las variables de entorno ANTHROPIC_API_KEY, ANTHROPIC_AUTH_TOKEN y ANTHROPIC_BASE_URL
AnthropicClient client = new();
IChatClient chatClient = client.AsIChatClient("claude-opus-5")
.AsBuilder()
.UseFunctionInvocation()
.Build();
// Usando McpClient del SDK de C# de MCP
McpClient learningServer = await McpClient.CreateAsync(
new HttpClientTransport(new() { Endpoint = new("https://learn.microsoft.com/api/mcp") }));
ChatOptions options = new() { Tools = [.. await learningServer.ListToolsAsync()] };
Console.WriteLine(await chatClient.GetResponseAsync("Tell me about IChatClient", options));Solicitudes y respuestas
Para enviar una solicitud a la Claude API, construye una instancia de una clase Params y pásala al método del cliente correspondiente. Cuando se recibe la respuesta, se deserializa en una instancia de una clase de C#.
Por ejemplo, client.Messages.Create debe llamarse con una instancia de MessageCreateParams, y devolverá una instancia de Task<Message>.
Uso avanzado
Respuestas binarias
El SDK define métodos que devuelven respuestas binarias, que se usan para respuestas de la API que no necesariamente deben analizarse, como datos que no son JSON.
Estos métodos devuelven HttpResponse:
using System;
using Anthropic.Models.Files;
FileDownloadParams parameters = new() { FileID = "file_id" };
var response = await client.Files.Download(parameters);
Console.WriteLine(response);Para guardar el contenido de la respuesta en un archivo, o en cualquier Stream, usa el método CopyToAsync:
using System.IO;
using var response = await client.Files.Download(parameters);
using var contentStream = await response.ReadAsStream();
using var fileStream = File.Open(path, FileMode.OpenOrCreate);
await contentStream.CopyToAsync(fileStream); // Or any other StreamRespuestas sin procesar
El SDK define métodos que deserializan las respuestas en instancias de clases de C#. Para acceder a los encabezados de la respuesta, al código de estado o al cuerpo sin procesar de la respuesta, antepón WithRawResponse a cualquier llamada a un método HTTP en un cliente o servicio:
var response = await client.WithRawResponse.Messages.Create(parameters);
var statusCode = response.StatusCode;
var headers = response.Headers;También se puede acceder al HttpResponseMessage sin procesar a través de la propiedad RawMessage.
Para respuestas sin streaming, puedes deserializar la respuesta en una instancia de una clase de C# si es necesario:
using System;
using Anthropic.Models.Messages;
var response = await client.WithRawResponse.Messages.Create(parameters);
Message deserialized = await response.Deserialize();
Console.WriteLine(deserialized);Para respuestas con streaming, puedes deserializar la respuesta en un IAsyncEnumerable si es necesario:
using System;
var response = await client.WithRawResponse.Messages.CreateStreaming(parameters);
await foreach (var item in response.Enumerate())
{
Console.WriteLine(item);
}Registro de logs
Habilita el registro de depuración estableciendo una variable de entorno:
export ANTHROPIC_LOG=debugFuncionalidad no documentada de la API
El SDK está tipado para un uso conveniente de la API documentada. Sin embargo, también admite trabajar con partes de la API no documentadas o aún no compatibles.
Integraciones con plataformas
El SDK de C# es compatible con las siguientes plataformas a través de paquetes NuGet separados:
- Agent Platform:
Anthropic.Vertex. Consulta Claude en Google Cloud para la configuración del cliente. - Bedrock:
Anthropic.Bedrock. UsaAnthropicBedrockMantleClientpara el endpoint de Bedrock de la Messages API, oAnthropicBedrockClient(rutabedrock-runtime).AnthropicBedrockMantleClientacepta un objeto de configuración opcionalMantleAwsClientOptions;AnthropicBedrockClientaceptaAnthropicBedrockCredentialsHelper.FromEnv()o credenciales explícitas. - Claude Platform en AWS:
Anthropic.Aws. UsaAnthropicAwsClient; estableceWorkspaceIden el cliente o la variable de entornoANTHROPIC_AWS_WORKSPACE_ID(consulta Workspaces). Disponible en beta. - Foundry:
Anthropic.Foundry. UsaAnthropicFoundryClientconDefaultAnthropicFoundryCredentials.FromEnv()o credenciales explícitas.
Usa AnthropicBedrockMantleClient para proyectos nuevos; AnthropicBedrockClient se mantiene para aplicaciones existentes que usan la API InvokeModel de Bedrock.
Versionado semántico
Este paquete generalmente sigue las convenciones de SemVer, aunque ciertos cambios incompatibles con versiones anteriores pueden publicarse como versiones menores:
- Cambios en los componentes internos de la biblioteca que técnicamente son públicos pero que no están destinados ni documentados para uso externo.
- Cambios que no se espera que afecten a la gran mayoría de los usuarios en la práctica.
La compatibilidad con versiones anteriores se toma en serio para garantizar que puedas confiar en una experiencia de actualización sin problemas.
Recursos adicionales
Was this page helpful?