@@ -163,7 +163,7 @@ Class AnthropicApiClient
+
Initializes a new instance of the AnthropicApiClient class.
@@ -207,9 +207,9 @@ Class AnthropicApiClient
-
- CancelMessageBatchAsync(string)
-
+
+ CancelMessageBatchAsync(string, CancellationToken)
+
Cancels a message batch asynchronously.
@@ -217,13 +217,16 @@ Class AnthropicApiClient
-
public Task<AnthropicResult<MessageBatchResponse>> CancelMessageBatchAsync(string batchId)
+
public Task<AnthropicResult<MessageBatchResponse>> CancelMessageBatchAsync(string batchId, CancellationToken cancellationToken = default)
Parameters
batchId stringThe ID of the message batch to cancel.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -246,9 +249,9 @@ Class AnthropicApiClient
-
- CountMessageTokensAsync(CountMessageTokensRequest)
-
+
+ CountMessageTokensAsync(CountMessageTokensRequest, CancellationToken)
+
Counts the tokens in a message asynchronously.
@@ -256,13 +259,16 @@ Class AnthropicApiClient
-
public Task<AnthropicResult<TokenCountResponse>> CountMessageTokensAsync(CountMessageTokensRequest request)
+
public Task<AnthropicResult<TokenCountResponse>> CountMessageTokensAsync(CountMessageTokensRequest request, CancellationToken cancellationToken = default)
Parameters
request CountMessageTokensRequestThe count message tokens request.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -285,9 +291,9 @@ Class AnthropicApiClient
-
- CreateMessageAsync(MessageRequest)
-
+
+ CreateMessageAsync(MessageRequest, CancellationToken)
+
Creates a message asynchronously.
@@ -295,13 +301,16 @@ Class AnthropicApiClient
-
public Task<AnthropicResult<MessageResponse>> CreateMessageAsync(MessageRequest request)
+
public Task<AnthropicResult<MessageResponse>> CreateMessageAsync(MessageRequest request, CancellationToken cancellationToken = default)
Parameters
request MessageRequestThe message request to create.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -324,9 +333,9 @@ Class AnthropicApiClient
-
- CreateMessageAsync(StreamMessageRequest)
-
+
+ CreateMessageAsync(StreamMessageRequest, CancellationToken)
+
Creates a message asynchronously and streams the response.
@@ -334,13 +343,16 @@ Class AnthropicApiClient
-
public IAsyncEnumerable<AnthropicEvent> CreateMessageAsync(StreamMessageRequest request)
+
public IAsyncEnumerable<AnthropicEvent> CreateMessageAsync(StreamMessageRequest request, CancellationToken cancellationToken = default)
Parameters
request StreamMessageRequestThe message request to create.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -363,9 +375,9 @@ Class AnthropicApiClient
-
- CreateMessageBatchAsync(MessageBatchRequest)
-
+
+ CreateMessageBatchAsync(MessageBatchRequest, CancellationToken)
+
Creates a batch of messages asynchronously.
@@ -373,13 +385,16 @@ Class AnthropicApiClient
-
public Task<AnthropicResult<MessageBatchResponse>> CreateMessageBatchAsync(MessageBatchRequest request)
+
public Task<AnthropicResult<MessageBatchResponse>> CreateMessageBatchAsync(MessageBatchRequest request, CancellationToken cancellationToken = default)
Parameters
request MessageBatchRequestThe message batch request to create.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -402,9 +417,9 @@ Class AnthropicApiClient
-
- DeleteMessageBatchAsync(string)
-
+
+ DeleteMessageBatchAsync(string, CancellationToken)
+
Deletes a message batch asynchronously.
@@ -412,13 +427,16 @@ Class AnthropicApiClient
-
public Task<AnthropicResult<MessageBatchDeleteResponse>> DeleteMessageBatchAsync(string batchId)
+
public Task<AnthropicResult<MessageBatchDeleteResponse>> DeleteMessageBatchAsync(string batchId, CancellationToken cancellationToken = default)
Parameters
batchId stringThe ID of the message batch to delete.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -441,9 +459,9 @@ Class AnthropicApiClient
-
- GetMessageBatchAsync(string)
-
+
+ GetMessageBatchAsync(string, CancellationToken)
+
Gets a message batch asynchronously.
@@ -451,13 +469,16 @@ Class AnthropicApiClient
-
public Task<AnthropicResult<MessageBatchResponse>> GetMessageBatchAsync(string batchId)
+
public Task<AnthropicResult<MessageBatchResponse>> GetMessageBatchAsync(string batchId, CancellationToken cancellationToken = default)
Parameters
batchId stringThe ID of the message batch to get.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -480,9 +501,9 @@ Class AnthropicApiClient
-
- GetMessageBatchResultsAsync(string)
-
+
+ GetMessageBatchResultsAsync(string, CancellationToken)
+
Gets the results of a message batch asynchronously.
@@ -490,13 +511,16 @@ Class AnthropicApiClient
-
public Task<AnthropicResult<IAsyncEnumerable<MessageBatchResultItem>>> GetMessageBatchResultsAsync(string batchId)
+
public Task<AnthropicResult<IAsyncEnumerable<MessageBatchResultItem>>> GetMessageBatchResultsAsync(string batchId, CancellationToken cancellationToken = default)
Parameters
batchId stringThe ID of the message batch to get the results for.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -519,9 +543,9 @@ Class AnthropicApiClient
-
- GetModelAsync(string)
-
+
+ GetModelAsync(string, CancellationToken)
+
Gets a model by its ID asynchronously.
@@ -529,13 +553,16 @@ Class AnthropicApiClient
-
public Task<AnthropicResult<AnthropicModel>> GetModelAsync(string modelId)
+
public Task<AnthropicResult<AnthropicModel>> GetModelAsync(string modelId, CancellationToken cancellationToken = default)
Parameters
modelId stringThe ID of the model to get.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -558,9 +585,9 @@ Class AnthropicApiClient
-
- ListAllMessageBatchesAsync(int)
-
+
+ ListAllMessageBatchesAsync(int, CancellationToken)
+
Lists all message batches asynchronously.
@@ -568,13 +595,16 @@ Class AnthropicApiClient
-
public IAsyncEnumerable<AnthropicResult<Page<MessageBatchResponse>>> ListAllMessageBatchesAsync(int limit = 20)
+
public IAsyncEnumerable<AnthropicResult<Page<MessageBatchResponse>>> ListAllMessageBatchesAsync(int limit = 20, CancellationToken cancellationToken = default)
Parameters
limit intThe maximum number of message batches to return in each page.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -597,23 +627,26 @@ Class AnthropicApiClient
-
- ListAllModelsAsync(int)
-
+
+ ListAllModelsAsync(int, CancellationToken)
+
- Lists the models asynchronously
+
Lists all models asynchronously, returning every page of results.
-
public IAsyncEnumerable<AnthropicResult<Page<AnthropicModel>>> ListAllModelsAsync(int limit = 20)
+
public IAsyncEnumerable<AnthropicResult<Page<AnthropicModel>>> ListAllModelsAsync(int limit = 20, CancellationToken cancellationToken = default)
Parameters
limit intThe maximum number of models to return in each page.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -636,9 +669,9 @@ Class AnthropicApiClient
-
- ListMessageBatchesAsync(PagingRequest?)
-
+
+ ListMessageBatchesAsync(PagingRequest?, CancellationToken)
+
Lists the message batches asynchronously.
@@ -646,13 +679,16 @@ Class AnthropicApiClient
-
public Task<AnthropicResult<Page<MessageBatchResponse>>> ListMessageBatchesAsync(PagingRequest? request = null)
+
public Task<AnthropicResult<Page<MessageBatchResponse>>> ListMessageBatchesAsync(PagingRequest? request = null, CancellationToken cancellationToken = default)
Parameters
request PagingRequestThe paging request to use for listing the message batches.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -675,23 +711,26 @@ Class AnthropicApiClient
-
- ListModelsAsync(PagingRequest?)
-
+
+ ListModelsAsync(PagingRequest?, CancellationToken)
+
- Lists the models asynchronously.
+
Lists models asynchronously, returning a single page of results.
-
public Task<AnthropicResult<Page<AnthropicModel>>> ListModelsAsync(PagingRequest? request = null)
+
public Task<AnthropicResult<Page<AnthropicModel>>> ListModelsAsync(PagingRequest? request = null, CancellationToken cancellationToken = default)
Parameters
request PagingRequestThe paging request to use for listing the models.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -716,7 +755,7 @@ Class AnthropicApiClient
Edit this page
+
Edit this page
- CancelMessageBatchAsync(string)
-
+
+ CancelMessageBatchAsync(string, CancellationToken)
+
Cancels a message batch asynchronously.
@@ -133,13 +133,16 @@ Interface IAnthropicApiClient
-
Task<AnthropicResult<MessageBatchResponse>> CancelMessageBatchAsync(string batchId)
+
Task<AnthropicResult<MessageBatchResponse>> CancelMessageBatchAsync(string batchId, CancellationToken cancellationToken = default)
Parameters
batchId stringThe ID of the message batch to cancel.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -162,9 +165,9 @@ Interface IAnthropicApiClient
-
- CountMessageTokensAsync(CountMessageTokensRequest)
-
+
+ CountMessageTokensAsync(CountMessageTokensRequest, CancellationToken)
+
Counts the tokens in a message asynchronously.
@@ -172,13 +175,16 @@ Interface IAnthropicApiClient
-
Task<AnthropicResult<TokenCountResponse>> CountMessageTokensAsync(CountMessageTokensRequest request)
+
Task<AnthropicResult<TokenCountResponse>> CountMessageTokensAsync(CountMessageTokensRequest request, CancellationToken cancellationToken = default)
Parameters
request CountMessageTokensRequestThe count message tokens request.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -201,9 +207,9 @@ Interface IAnthropicApiClient
-
- CreateMessageAsync(MessageRequest)
-
+
+ CreateMessageAsync(MessageRequest, CancellationToken)
+
Creates a message asynchronously.
@@ -211,13 +217,16 @@ Interface IAnthropicApiClient
-
Task<AnthropicResult<MessageResponse>> CreateMessageAsync(MessageRequest request)
+
Task<AnthropicResult<MessageResponse>> CreateMessageAsync(MessageRequest request, CancellationToken cancellationToken = default)
Parameters
request MessageRequestThe message request to create.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -240,9 +249,9 @@ Interface IAnthropicApiClient
-
- CreateMessageAsync(StreamMessageRequest)
-
+
+ CreateMessageAsync(StreamMessageRequest, CancellationToken)
+
Creates a message asynchronously and streams the response.
@@ -250,13 +259,16 @@ Interface IAnthropicApiClient
-
IAsyncEnumerable<AnthropicEvent> CreateMessageAsync(StreamMessageRequest request)
+
IAsyncEnumerable<AnthropicEvent> CreateMessageAsync(StreamMessageRequest request, CancellationToken cancellationToken = default)
Parameters
request StreamMessageRequestThe message request to create.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -279,9 +291,9 @@ Interface IAnthropicApiClient
-
- CreateMessageBatchAsync(MessageBatchRequest)
-
+
+ CreateMessageBatchAsync(MessageBatchRequest, CancellationToken)
+
Creates a batch of messages asynchronously.
@@ -289,13 +301,16 @@ Interface IAnthropicApiClient
-
Task<AnthropicResult<MessageBatchResponse>> CreateMessageBatchAsync(MessageBatchRequest request)
+
Task<AnthropicResult<MessageBatchResponse>> CreateMessageBatchAsync(MessageBatchRequest request, CancellationToken cancellationToken = default)
Parameters
request MessageBatchRequestThe message batch request to create.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -318,9 +333,9 @@ Interface IAnthropicApiClient
-
- DeleteMessageBatchAsync(string)
-
+
+ DeleteMessageBatchAsync(string, CancellationToken)
+
Deletes a message batch asynchronously.
@@ -328,13 +343,16 @@ Interface IAnthropicApiClient
-
Task<AnthropicResult<MessageBatchDeleteResponse>> DeleteMessageBatchAsync(string batchId)
+
Task<AnthropicResult<MessageBatchDeleteResponse>> DeleteMessageBatchAsync(string batchId, CancellationToken cancellationToken = default)
Parameters
batchId stringThe ID of the message batch to delete.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -357,9 +375,9 @@ Interface IAnthropicApiClient
-
- GetMessageBatchAsync(string)
-
+
+ GetMessageBatchAsync(string, CancellationToken)
+
Gets a message batch asynchronously.
@@ -367,13 +385,16 @@ Interface IAnthropicApiClient
-
Task<AnthropicResult<MessageBatchResponse>> GetMessageBatchAsync(string batchId)
+
Task<AnthropicResult<MessageBatchResponse>> GetMessageBatchAsync(string batchId, CancellationToken cancellationToken = default)
Parameters
batchId stringThe ID of the message batch to get.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -396,9 +417,9 @@ Interface IAnthropicApiClient
-
- GetMessageBatchResultsAsync(string)
-
+
+ GetMessageBatchResultsAsync(string, CancellationToken)
+
Gets the results of a message batch asynchronously.
@@ -406,13 +427,16 @@ Interface IAnthropicApiClient
-
Task<AnthropicResult<IAsyncEnumerable<MessageBatchResultItem>>> GetMessageBatchResultsAsync(string batchId)
+
Task<AnthropicResult<IAsyncEnumerable<MessageBatchResultItem>>> GetMessageBatchResultsAsync(string batchId, CancellationToken cancellationToken = default)
Parameters
batchId stringThe ID of the message batch to get the results for.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -435,9 +459,9 @@ Interface IAnthropicApiClient
-
- GetModelAsync(string)
-
+
+ GetModelAsync(string, CancellationToken)
+
Gets a model by its ID asynchronously.
@@ -445,13 +469,16 @@ Interface IAnthropicApiClient
-
Task<AnthropicResult<AnthropicModel>> GetModelAsync(string modelId)
+
Task<AnthropicResult<AnthropicModel>> GetModelAsync(string modelId, CancellationToken cancellationToken = default)
Parameters
modelId stringThe ID of the model to get.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -474,9 +501,9 @@ Interface IAnthropicApiClient
-
- ListAllMessageBatchesAsync(int)
-
+
+ ListAllMessageBatchesAsync(int, CancellationToken)
+
Lists all message batches asynchronously.
@@ -484,13 +511,16 @@ Interface IAnthropicApiClient
-
IAsyncEnumerable<AnthropicResult<Page<MessageBatchResponse>>> ListAllMessageBatchesAsync(int limit = 20)
+
IAsyncEnumerable<AnthropicResult<Page<MessageBatchResponse>>> ListAllMessageBatchesAsync(int limit = 20, CancellationToken cancellationToken = default)
Parameters
limit intThe maximum number of message batches to return in each page.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -513,23 +543,26 @@ Interface IAnthropicApiClient
-
- ListAllModelsAsync(int)
-
+
+ ListAllModelsAsync(int, CancellationToken)
+
- Lists the models asynchronously
+
Lists all models asynchronously, returning every page of results.
-
IAsyncEnumerable<AnthropicResult<Page<AnthropicModel>>> ListAllModelsAsync(int limit = 20)
+
IAsyncEnumerable<AnthropicResult<Page<AnthropicModel>>> ListAllModelsAsync(int limit = 20, CancellationToken cancellationToken = default)
Parameters
limit intThe maximum number of models to return in each page.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -552,9 +585,9 @@ Interface IAnthropicApiClient
-
- ListMessageBatchesAsync(PagingRequest?)
-
+
+ ListMessageBatchesAsync(PagingRequest?, CancellationToken)
+
Lists the message batches asynchronously.
@@ -562,13 +595,16 @@ Interface IAnthropicApiClient
-
Task<AnthropicResult<Page<MessageBatchResponse>>> ListMessageBatchesAsync(PagingRequest? request = null)
+
Task<AnthropicResult<Page<MessageBatchResponse>>> ListMessageBatchesAsync(PagingRequest? request = null, CancellationToken cancellationToken = default)
Parameters
request PagingRequestThe paging request to use for listing the message batches.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
@@ -591,23 +627,26 @@ Interface IAnthropicApiClient
-
- ListModelsAsync(PagingRequest?)
-
+
+ ListModelsAsync(PagingRequest?, CancellationToken)
+
- Lists the models asynchronously.
+
Lists models asynchronously, returning a single page of results.
-
Task<AnthropicResult<Page<AnthropicModel>>> ListModelsAsync(PagingRequest? request = null)
+
Task<AnthropicResult<Page<AnthropicModel>>> ListModelsAsync(PagingRequest? request = null, CancellationToken cancellationToken = default)
Parameters
request PagingRequestThe paging request to use for listing the models.
+cancellationToken CancellationTokenA token to cancel the asynchronous operation.
diff --git a/docs/index.json b/docs/index.json
index 93ccff0..7c06a8c 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -2,441 +2,441 @@
"api/AnthropicClient.AnthropicApiClient.html": {
"href": "api/AnthropicClient.AnthropicApiClient.html",
"title": "Class AnthropicApiClient | AnthropicClient",
- "keywords": "Class AnthropicApiClient Namespace AnthropicClient Assembly AnthropicClient.dll Represents a client for interacting with the Anthropic API. public class AnthropicApiClient : IAnthropicApiClient Inheritance object AnthropicApiClient Implements IAnthropicApiClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnthropicApiClient(string, HttpClient) Initializes a new instance of the AnthropicApiClient class. public AnthropicApiClient(string apiKey, HttpClient httpClient) Parameters apiKey string The API key to use for the client. httpClient HttpClient The HTTP client to use for the client. Exceptions ArgumentNullException Thrown when the API key or HTTP client is null. Methods CancelMessageBatchAsync(string) Cancels a message batch asynchronously. public Task
> CancelMessageBatchAsync(string batchId) Parameters batchId string The ID of the message batch to cancel. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. CountMessageTokensAsync(CountMessageTokensRequest) Counts the tokens in a message asynchronously. public Task> CountMessageTokensAsync(CountMessageTokensRequest request) Parameters request CountMessageTokensRequest The count message tokens request. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is TokenCountResponse. CreateMessageAsync(MessageRequest) Creates a message asynchronously. public Task> CreateMessageAsync(MessageRequest request) Parameters request MessageRequest The message request to create. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult. CreateMessageAsync(StreamMessageRequest) Creates a message asynchronously and streams the response. public IAsyncEnumerable CreateMessageAsync(StreamMessageRequest request) Parameters request StreamMessageRequest The message request to create. Returns IAsyncEnumerable An asynchronous enumerable that yields the response event by event. CreateMessageBatchAsync(MessageBatchRequest) Creates a batch of messages asynchronously. public Task> CreateMessageBatchAsync(MessageBatchRequest request) Parameters request MessageBatchRequest The message batch request to create. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. DeleteMessageBatchAsync(string) Deletes a message batch asynchronously. public Task> DeleteMessageBatchAsync(string batchId) Parameters batchId string The ID of the message batch to delete. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchDeleteResponse. GetMessageBatchAsync(string) Gets a message batch asynchronously. public Task> GetMessageBatchAsync(string batchId) Parameters batchId string The ID of the message batch to get. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. GetMessageBatchResultsAsync(string) Gets the results of a message batch asynchronously. public Task>> GetMessageBatchResultsAsync(string batchId) Parameters batchId string The ID of the message batch to get the results for. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is IAsyncEnumerable where T is MessageBatchResultItem. GetModelAsync(string) Gets a model by its ID asynchronously. public Task> GetModelAsync(string modelId) Parameters modelId string The ID of the model to get. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is AnthropicModel. ListAllMessageBatchesAsync(int) Lists all message batches asynchronously. public IAsyncEnumerable>> ListAllMessageBatchesAsync(int limit = 20) Parameters limit int The maximum number of message batches to return in each page. Returns IAsyncEnumerable>> An asynchronous enumerable that yields the response as an AnthropicResult where T is Page where T is MessageBatchResponse. ListAllModelsAsync(int) Lists the models asynchronously public IAsyncEnumerable>> ListAllModelsAsync(int limit = 20) Parameters limit int The maximum number of models to return in each page. Returns IAsyncEnumerable>> An asynchronous enumerable that yields the response as an AnthropicResult where T is Page where T is AnthropicModel. ListMessageBatchesAsync(PagingRequest?) Lists the message batches asynchronously. public Task>> ListMessageBatchesAsync(PagingRequest? request = null) Parameters request PagingRequest The paging request to use for listing the message batches. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is Page where T is MessageBatchResponse. ListModelsAsync(PagingRequest?) Lists the models asynchronously. public Task>> ListModelsAsync(PagingRequest? request = null) Parameters request PagingRequest The paging request to use for listing the models. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is Page where T is AnthropicModel."
+ "summary": "Class AnthropicApiClient Namespace AnthropicClient Assembly AnthropicClient.dll Represents a client for interacting with the Anthropic API. public class AnthropicApiClient : IAnthropicApiClient Inheritance object AnthropicApiClient Implements IAnthropicApiClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnthropicApiClient(string, HttpClient) Initializes a new instance of the AnthropicApiClient class. public AnthropicApiClient(string apiKey, HttpClient httpClient) Parameters apiKey string The API key to use for the client. httpClient HttpClient The HTTP client to use for the client. Exceptions ArgumentNullException Thrown when the API key or HTTP client is null. Methods CancelMessageBatchAsync(string, CancellationToken) Cancels a message batch asynchronously. public Task> CancelMessageBatchAsync(string batchId, CancellationToken cancellationToken = default) Parameters batchId string The ID of the message batch to cancel. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. CountMessageTokensAsync(CountMessageTokensRequest, CancellationToken) Counts the tokens in a message asynchronously. public Task> CountMessageTokensAsync(CountMessageTokensRequest request, CancellationToken cancellationToken = default) Parameters request CountMessageTokensRequest The count message tokens request. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is TokenCountResponse. CreateMessageAsync(MessageRequest, CancellationToken) Creates a message asynchronously. public Task> CreateMessageAsync(MessageRequest request, CancellationToken cancellationToken = default) Parameters request MessageRequest The message request to create. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult. CreateMessageAsync(StreamMessageRequest, CancellationToken) Creates a message asynchronously and streams the response. public IAsyncEnumerable CreateMessageAsync(StreamMessageRequest request, CancellationToken cancellationToken = default) Parameters request StreamMessageRequest The message request to create. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns IAsyncEnumerable An asynchronous enumerable that yields the response event by event. CreateMessageBatchAsync(MessageBatchRequest, CancellationToken) Creates a batch of messages asynchronously. public Task> CreateMessageBatchAsync(MessageBatchRequest request, CancellationToken cancellationToken = default) Parameters request MessageBatchRequest The message batch request to create. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. DeleteMessageBatchAsync(string, CancellationToken) Deletes a message batch asynchronously. public Task> DeleteMessageBatchAsync(string batchId, CancellationToken cancellationToken = default) Parameters batchId string The ID of the message batch to delete. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchDeleteResponse. GetMessageBatchAsync(string, CancellationToken) Gets a message batch asynchronously. public Task> GetMessageBatchAsync(string batchId, CancellationToken cancellationToken = default) Parameters batchId string The ID of the message batch to get. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. GetMessageBatchResultsAsync(string, CancellationToken) Gets the results of a message batch asynchronously. public Task>> GetMessageBatchResultsAsync(string batchId, CancellationToken cancellationToken = default) Parameters batchId string The ID of the message batch to get the results for. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is IAsyncEnumerable where T is MessageBatchResultItem. GetModelAsync(string, CancellationToken) Gets a model by its ID asynchronously. public Task> GetModelAsync(string modelId, CancellationToken cancellationToken = default) Parameters modelId string The ID of the model to get. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is AnthropicModel. ListAllMessageBatchesAsync(int, CancellationToken) Lists all message batches asynchronously. public IAsyncEnumerable>> ListAllMessageBatchesAsync(int limit = 20, CancellationToken cancellationToken = default) Parameters limit int The maximum number of message batches to return in each page. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns IAsyncEnumerable>> An asynchronous enumerable that yields the response as an AnthropicResult where T is Page where T is MessageBatchResponse. ListAllModelsAsync(int, CancellationToken) Lists all models asynchronously, returning every page of results. public IAsyncEnumerable>> ListAllModelsAsync(int limit = 20, CancellationToken cancellationToken = default) Parameters limit int The maximum number of models to return in each page. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns IAsyncEnumerable>> An asynchronous enumerable that yields the response as an AnthropicResult where T is Page where T is AnthropicModel. ListMessageBatchesAsync(PagingRequest?, CancellationToken) Lists the message batches asynchronously. public Task>> ListMessageBatchesAsync(PagingRequest? request = null, CancellationToken cancellationToken = default) Parameters request PagingRequest The paging request to use for listing the message batches. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is Page where T is MessageBatchResponse. ListModelsAsync(PagingRequest?, CancellationToken) Lists models asynchronously, returning a single page of results. public Task>> ListModelsAsync(PagingRequest? request = null, CancellationToken cancellationToken = default) Parameters request PagingRequest The paging request to use for listing the models. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is Page where T is AnthropicModel."
},
"api/AnthropicClient.IAnthropicApiClient.html": {
"href": "api/AnthropicClient.IAnthropicApiClient.html",
"title": "Interface IAnthropicApiClient | AnthropicClient",
- "keywords": "Interface IAnthropicApiClient Namespace AnthropicClient Assembly AnthropicClient.dll Represents a client for interacting with the Anthropic API. public interface IAnthropicApiClient Methods CancelMessageBatchAsync(string) Cancels a message batch asynchronously. Task> CancelMessageBatchAsync(string batchId) Parameters batchId string The ID of the message batch to cancel. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. CountMessageTokensAsync(CountMessageTokensRequest) Counts the tokens in a message asynchronously. Task> CountMessageTokensAsync(CountMessageTokensRequest request) Parameters request CountMessageTokensRequest The count message tokens request. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is TokenCountResponse. CreateMessageAsync(MessageRequest) Creates a message asynchronously. Task> CreateMessageAsync(MessageRequest request) Parameters request MessageRequest The message request to create. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult. CreateMessageAsync(StreamMessageRequest) Creates a message asynchronously and streams the response. IAsyncEnumerable CreateMessageAsync(StreamMessageRequest request) Parameters request StreamMessageRequest The message request to create. Returns IAsyncEnumerable An asynchronous enumerable that yields the response event by event. CreateMessageBatchAsync(MessageBatchRequest) Creates a batch of messages asynchronously. Task> CreateMessageBatchAsync(MessageBatchRequest request) Parameters request MessageBatchRequest The message batch request to create. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. DeleteMessageBatchAsync(string) Deletes a message batch asynchronously. Task> DeleteMessageBatchAsync(string batchId) Parameters batchId string The ID of the message batch to delete. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchDeleteResponse. GetMessageBatchAsync(string) Gets a message batch asynchronously. Task> GetMessageBatchAsync(string batchId) Parameters batchId string The ID of the message batch to get. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. GetMessageBatchResultsAsync(string) Gets the results of a message batch asynchronously. Task>> GetMessageBatchResultsAsync(string batchId) Parameters batchId string The ID of the message batch to get the results for. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is IAsyncEnumerable where T is MessageBatchResultItem. GetModelAsync(string) Gets a model by its ID asynchronously. Task> GetModelAsync(string modelId) Parameters modelId string The ID of the model to get. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is AnthropicModel. ListAllMessageBatchesAsync(int) Lists all message batches asynchronously. IAsyncEnumerable>> ListAllMessageBatchesAsync(int limit = 20) Parameters limit int The maximum number of message batches to return in each page. Returns IAsyncEnumerable>> An asynchronous enumerable that yields the response as an AnthropicResult where T is Page where T is MessageBatchResponse. ListAllModelsAsync(int) Lists the models asynchronously IAsyncEnumerable>> ListAllModelsAsync(int limit = 20) Parameters limit int The maximum number of models to return in each page. Returns IAsyncEnumerable>> An asynchronous enumerable that yields the response as an AnthropicResult where T is Page where T is AnthropicModel. ListMessageBatchesAsync(PagingRequest?) Lists the message batches asynchronously. Task>> ListMessageBatchesAsync(PagingRequest? request = null) Parameters request PagingRequest The paging request to use for listing the message batches. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is Page where T is MessageBatchResponse. ListModelsAsync(PagingRequest?) Lists the models asynchronously. Task>> ListModelsAsync(PagingRequest? request = null) Parameters request PagingRequest The paging request to use for listing the models. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is Page where T is AnthropicModel."
+ "summary": "Interface IAnthropicApiClient Namespace AnthropicClient Assembly AnthropicClient.dll Represents a client for interacting with the Anthropic API. public interface IAnthropicApiClient Methods CancelMessageBatchAsync(string, CancellationToken) Cancels a message batch asynchronously. Task> CancelMessageBatchAsync(string batchId, CancellationToken cancellationToken = default) Parameters batchId string The ID of the message batch to cancel. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. CountMessageTokensAsync(CountMessageTokensRequest, CancellationToken) Counts the tokens in a message asynchronously. Task> CountMessageTokensAsync(CountMessageTokensRequest request, CancellationToken cancellationToken = default) Parameters request CountMessageTokensRequest The count message tokens request. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is TokenCountResponse. CreateMessageAsync(MessageRequest, CancellationToken) Creates a message asynchronously. Task> CreateMessageAsync(MessageRequest request, CancellationToken cancellationToken = default) Parameters request MessageRequest The message request to create. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult. CreateMessageAsync(StreamMessageRequest, CancellationToken) Creates a message asynchronously and streams the response. IAsyncEnumerable CreateMessageAsync(StreamMessageRequest request, CancellationToken cancellationToken = default) Parameters request StreamMessageRequest The message request to create. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns IAsyncEnumerable An asynchronous enumerable that yields the response event by event. CreateMessageBatchAsync(MessageBatchRequest, CancellationToken) Creates a batch of messages asynchronously. Task> CreateMessageBatchAsync(MessageBatchRequest request, CancellationToken cancellationToken = default) Parameters request MessageBatchRequest The message batch request to create. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. DeleteMessageBatchAsync(string, CancellationToken) Deletes a message batch asynchronously. Task> DeleteMessageBatchAsync(string batchId, CancellationToken cancellationToken = default) Parameters batchId string The ID of the message batch to delete. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchDeleteResponse. GetMessageBatchAsync(string, CancellationToken) Gets a message batch asynchronously. Task> GetMessageBatchAsync(string batchId, CancellationToken cancellationToken = default) Parameters batchId string The ID of the message batch to get. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is MessageBatchResponse. GetMessageBatchResultsAsync(string, CancellationToken) Gets the results of a message batch asynchronously. Task>> GetMessageBatchResultsAsync(string batchId, CancellationToken cancellationToken = default) Parameters batchId string The ID of the message batch to get the results for. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is IAsyncEnumerable where T is MessageBatchResultItem. GetModelAsync(string, CancellationToken) Gets a model by its ID asynchronously. Task> GetModelAsync(string modelId, CancellationToken cancellationToken = default) Parameters modelId string The ID of the model to get. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is AnthropicModel. ListAllMessageBatchesAsync(int, CancellationToken) Lists all message batches asynchronously. IAsyncEnumerable>> ListAllMessageBatchesAsync(int limit = 20, CancellationToken cancellationToken = default) Parameters limit int The maximum number of message batches to return in each page. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns IAsyncEnumerable>> An asynchronous enumerable that yields the response as an AnthropicResult where T is Page where T is MessageBatchResponse. ListAllModelsAsync(int, CancellationToken) Lists all models asynchronously, returning every page of results. IAsyncEnumerable>> ListAllModelsAsync(int limit = 20, CancellationToken cancellationToken = default) Parameters limit int The maximum number of models to return in each page. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns IAsyncEnumerable>> An asynchronous enumerable that yields the response as an AnthropicResult where T is Page where T is AnthropicModel. ListMessageBatchesAsync(PagingRequest?, CancellationToken) Lists the message batches asynchronously. Task>> ListMessageBatchesAsync(PagingRequest? request = null, CancellationToken cancellationToken = default) Parameters request PagingRequest The paging request to use for listing the message batches. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is Page where T is MessageBatchResponse. ListModelsAsync(PagingRequest?, CancellationToken) Lists models asynchronously, returning a single page of results. Task>> ListModelsAsync(PagingRequest? request = null, CancellationToken cancellationToken = default) Parameters request PagingRequest The paging request to use for listing the models. cancellationToken CancellationToken A token to cancel the asynchronous operation. Returns Task>> A task that represents the asynchronous operation. The task result contains the response as an AnthropicResult where T is Page where T is AnthropicModel."
},
"api/AnthropicClient.Models.AnthropicError.html": {
"href": "api/AnthropicClient.Models.AnthropicError.html",
"title": "Class AnthropicError | AnthropicClient",
- "keywords": "Class AnthropicError Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an error response from the Anthropic API. public class AnthropicError Inheritance object AnthropicError Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnthropicError(Error) Initializes a new instance of the AnthropicError class. public AnthropicError(Error error) Parameters error Error The error as an Error object. Properties Error The error object. public Error Error { get; init; } Property Value Error Type The type of the error. public string Type { get; init; } Property Value string"
+ "summary": "Class AnthropicError Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an error response from the Anthropic API. public class AnthropicError Inheritance object AnthropicError Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnthropicError(Error) Initializes a new instance of the AnthropicError class. public AnthropicError(Error error) Parameters error Error The error as an Error object. Properties Error The error object. public Error Error { get; init; } Property Value Error Type The type of the error. public string Type { get; init; } Property Value string"
},
"api/AnthropicClient.Models.AnthropicEvent.html": {
"href": "api/AnthropicClient.Models.AnthropicEvent.html",
"title": "Class AnthropicEvent | AnthropicClient",
- "keywords": "Class AnthropicEvent Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an event from the Anthropic API. public class AnthropicEvent Inheritance object AnthropicEvent Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnthropicEvent(string, EventData) Initializes a new instance of the AnthropicEvent class. public AnthropicEvent(string type, EventData data) Parameters type string The type of the event. data EventData The data associated with the event. Properties Data The data associated with the event. public EventData Data { get; init; } Property Value EventData Type The type of the event. public string Type { get; init; } Property Value string"
+ "summary": "Class AnthropicEvent Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an event from the Anthropic API. public class AnthropicEvent Inheritance object AnthropicEvent Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnthropicEvent(string, EventData) Initializes a new instance of the AnthropicEvent class. public AnthropicEvent(string type, EventData data) Parameters type string The type of the event. data EventData The data associated with the event. Properties Data The data associated with the event. public EventData Data { get; init; } Property Value EventData Type The type of the event. public string Type { get; init; } Property Value string"
},
"api/AnthropicClient.Models.AnthropicFunction.html": {
"href": "api/AnthropicClient.Models.AnthropicFunction.html",
"title": "Class AnthropicFunction | AnthropicClient",
- "keywords": "Class AnthropicFunction Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents a function that can be provided as a tool. public class AnthropicFunction Inheritance object AnthropicFunction Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties Instance Gets the instance on which the method is invoked. public object? Instance { get; } Property Value object Method Gets the method of the function. public MethodInfo Method { get; } Property Value MethodInfo"
+ "summary": "Class AnthropicFunction Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents a function that can be provided as a tool. public class AnthropicFunction Inheritance object AnthropicFunction Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties Instance Gets the instance on which the method is invoked. public object? Instance { get; } Property Value object Method Gets the method of the function. public MethodInfo Method { get; } Property Value MethodInfo"
},
"api/AnthropicClient.Models.AnthropicHeaders.html": {
"href": "api/AnthropicClient.Models.AnthropicHeaders.html",
"title": "Class AnthropicHeaders | AnthropicClient",
- "keywords": "Class AnthropicHeaders Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents headers included in Anthropic API responses. public class AnthropicHeaders Inheritance object AnthropicHeaders Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnthropicHeaders(HttpResponseHeaders) Initializes a new instance of the AnthropicHeaders class. public AnthropicHeaders(HttpResponseHeaders headers) Parameters headers HttpResponseHeaders The HTTP response headers. Properties RateLimitRequestsLimit Gets the rate limit requests limit. public int RateLimitRequestsLimit { get; init; } Property Value int RateLimitRequestsRemaining Gets the rate limit requests remaining. public int RateLimitRequestsRemaining { get; init; } Property Value int RateLimitRequestsReset Gets the time of the rate limit requests reset. public DateTimeOffset RateLimitRequestsReset { get; init; } Property Value DateTimeOffset RateLimitTokensLimit Gets the rate limit tokens limit. public int RateLimitTokensLimit { get; init; } Property Value int RateLimitTokensRemaining Gets the rate limit tokens remaining. public int RateLimitTokensRemaining { get; init; } Property Value int RateLimitTokensReset Gets the time of the rate limit tokens reset. public DateTimeOffset RateLimitTokensReset { get; init; } Property Value DateTimeOffset RequestId Gets the request ID. public string RequestId { get; init; } Property Value string RetryAfter Gets the retry after value. public int RetryAfter { get; init; } Property Value int"
+ "summary": "Class AnthropicHeaders Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents headers included in Anthropic API responses. public class AnthropicHeaders Inheritance object AnthropicHeaders Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnthropicHeaders(HttpResponseHeaders) Initializes a new instance of the AnthropicHeaders class. public AnthropicHeaders(HttpResponseHeaders headers) Parameters headers HttpResponseHeaders The HTTP response headers. Properties RateLimitRequestsLimit Gets the rate limit requests limit. public int RateLimitRequestsLimit { get; init; } Property Value int RateLimitRequestsRemaining Gets the rate limit requests remaining. public int RateLimitRequestsRemaining { get; init; } Property Value int RateLimitRequestsReset Gets the time of the rate limit requests reset. public DateTimeOffset RateLimitRequestsReset { get; init; } Property Value DateTimeOffset RateLimitTokensLimit Gets the rate limit tokens limit. public int RateLimitTokensLimit { get; init; } Property Value int RateLimitTokensRemaining Gets the rate limit tokens remaining. public int RateLimitTokensRemaining { get; init; } Property Value int RateLimitTokensReset Gets the time of the rate limit tokens reset. public DateTimeOffset RateLimitTokensReset { get; init; } Property Value DateTimeOffset RequestId Gets the request ID. public string RequestId { get; init; } Property Value string RetryAfter Gets the retry after value. public int RetryAfter { get; init; } Property Value int"
},
"api/AnthropicClient.Models.AnthropicModel.html": {
"href": "api/AnthropicClient.Models.AnthropicModel.html",
"title": "Class AnthropicModel | AnthropicClient",
- "keywords": "Class AnthropicModel Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an Anthropic model. public class AnthropicModel Inheritance object AnthropicModel Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties CreatedAt The created date of the model. [JsonPropertyName(\"created_at\")] public DateTimeOffset CreatedAt { get; init; } Property Value DateTimeOffset DisplayName The display name of the model. [JsonPropertyName(\"display_name\")] public string DisplayName { get; init; } Property Value string Id The id of the model. public string Id { get; init; } Property Value string Type The type of the model. public string Type { get; init; } Property Value string"
+ "summary": "Class AnthropicModel Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an Anthropic model. public class AnthropicModel Inheritance object AnthropicModel Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties CreatedAt The created date of the model. [JsonPropertyName(\"created_at\")] public DateTimeOffset CreatedAt { get; init; } Property Value DateTimeOffset DisplayName The display name of the model. [JsonPropertyName(\"display_name\")] public string DisplayName { get; init; } Property Value string Id The id of the model. public string Id { get; init; } Property Value string Type The type of the model. public string Type { get; init; } Property Value string"
},
"api/AnthropicClient.Models.AnthropicModels.html": {
"href": "api/AnthropicClient.Models.AnthropicModels.html",
"title": "Class AnthropicModels | AnthropicClient",
- "keywords": "Class AnthropicModels Namespace AnthropicClient.Models Assembly AnthropicClient.dll Provides constants for the Anthropic models. public static class AnthropicModels Inheritance object AnthropicModels Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields Claude35Haiku20241022 The Claude 3.5 Haiku model. public const string Claude35Haiku20241022 = \"claude-3-5-haiku-20241022\" Field Value string Claude35HaikuLatest The Claude 3.5 Haiku model. public const string Claude35HaikuLatest = \"claude-3-5-haiku-latest\" Field Value string Claude35Sonnet The Claude 3.5 Sonnet model. public const string Claude35Sonnet = \"claude-3-5-sonnet-20240620\" Field Value string Claude35Sonnet20240620 The Claude 3.5 Sonnet model. public const string Claude35Sonnet20240620 = \"claude-3-5-sonnet-20240620\" Field Value string Claude35Sonnet20241022 The Claude 3.5 Sonnet model. public const string Claude35Sonnet20241022 = \"claude-3-5-sonnet-20241022\" Field Value string Claude35SonnetLatest The Claude 3.5 Sonnet model. public const string Claude35SonnetLatest = \"claude-3-5-sonnet-latest\" Field Value string Claude3Haiku The Claude 3 Haiku model. public const string Claude3Haiku = \"claude-3-haiku-20240307\" Field Value string Claude3Haiku20240307 The Claude 3 Haiku model. public const string Claude3Haiku20240307 = \"claude-3-haiku-20240307\" Field Value string Claude3Opus The Claude 3 Opus model. public const string Claude3Opus = \"claude-3-opus-20240229\" Field Value string Claude3Opus20241022 The Claude 3 Opus model. public const string Claude3Opus20241022 = \"claude-3-opus-20240229\" Field Value string Claude3OpusLatest The Claude 3 Opus model. public const string Claude3OpusLatest = \"claude-3-opus-latest\" Field Value string Claude3Sonnet The Claude 3 Sonnet model. public const string Claude3Sonnet = \"claude-3-sonnet-20240229\" Field Value string Claude3Sonnet20240229 The Claude 3 Sonnet model. public const string Claude3Sonnet20240229 = \"claude-3-sonnet-20240229\" Field Value string"
+ "summary": "Class AnthropicModels Namespace AnthropicClient.Models Assembly AnthropicClient.dll Provides constants for the Anthropic models. public static class AnthropicModels Inheritance object AnthropicModels Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields Claude35Haiku20241022 The Claude 3.5 Haiku model. public const string Claude35Haiku20241022 = \"claude-3-5-haiku-20241022\" Field Value string Claude35HaikuLatest The Claude 3.5 Haiku model. public const string Claude35HaikuLatest = \"claude-3-5-haiku-latest\" Field Value string Claude35Sonnet The Claude 3.5 Sonnet model. public const string Claude35Sonnet = \"claude-3-5-sonnet-20240620\" Field Value string Claude35Sonnet20240620 The Claude 3.5 Sonnet model. public const string Claude35Sonnet20240620 = \"claude-3-5-sonnet-20240620\" Field Value string Claude35Sonnet20241022 The Claude 3.5 Sonnet model. public const string Claude35Sonnet20241022 = \"claude-3-5-sonnet-20241022\" Field Value string Claude35SonnetLatest The Claude 3.5 Sonnet model. public const string Claude35SonnetLatest = \"claude-3-5-sonnet-latest\" Field Value string Claude3Haiku The Claude 3 Haiku model. public const string Claude3Haiku = \"claude-3-haiku-20240307\" Field Value string Claude3Haiku20240307 The Claude 3 Haiku model. public const string Claude3Haiku20240307 = \"claude-3-haiku-20240307\" Field Value string Claude3Opus The Claude 3 Opus model. public const string Claude3Opus = \"claude-3-opus-20240229\" Field Value string Claude3Opus20241022 The Claude 3 Opus model. public const string Claude3Opus20241022 = \"claude-3-opus-20240229\" Field Value string Claude3OpusLatest The Claude 3 Opus model. public const string Claude3OpusLatest = \"claude-3-opus-latest\" Field Value string Claude3Sonnet The Claude 3 Sonnet model. public const string Claude3Sonnet = \"claude-3-sonnet-20240229\" Field Value string Claude3Sonnet20240229 The Claude 3 Sonnet model. public const string Claude3Sonnet20240229 = \"claude-3-sonnet-20240229\" Field Value string"
},
"api/AnthropicClient.Models.AnyToolChoice.html": {
"href": "api/AnthropicClient.Models.AnyToolChoice.html",
"title": "Class AnyToolChoice | AnthropicClient",
- "keywords": "Class AnyToolChoice Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents the any tool choice mode. public class AnyToolChoice : ToolChoice Inheritance object ToolChoice AnyToolChoice Inherited Members ToolChoice.Type object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnyToolChoice() Initializes a new instance of the AnyToolChoice class. public AnyToolChoice()"
+ "summary": "Class AnyToolChoice Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents the any tool choice mode. public class AnyToolChoice : ToolChoice Inheritance object ToolChoice AnyToolChoice Inherited Members ToolChoice.Type object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AnyToolChoice() Initializes a new instance of the AnyToolChoice class. public AnyToolChoice()"
},
"api/AnthropicClient.Models.ApiError.html": {
"href": "api/AnthropicClient.Models.ApiError.html",
"title": "Class ApiError | AnthropicClient",
- "keywords": "Class ApiError Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an api_error response from the Anthropic API. public class ApiError : Error Inheritance object Error ApiError Inherited Members Error.Type Error.Message object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors ApiError(string) Initializes a new instance of the ApiError class. public ApiError(string message) Parameters message string The error message."
+ "summary": "Class ApiError Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an api_error response from the Anthropic API. public class ApiError : Error Inheritance object Error ApiError Inherited Members Error.Type Error.Message object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors ApiError(string) Initializes a new instance of the ApiError class. public ApiError(string message) Parameters message string The error message."
},
"api/AnthropicClient.Models.AuthenticationError.html": {
"href": "api/AnthropicClient.Models.AuthenticationError.html",
"title": "Class AuthenticationError | AnthropicClient",
- "keywords": "Class AuthenticationError Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an authentication_error response from the Anthropic API. public class AuthenticationError : Error Inheritance object Error AuthenticationError Inherited Members Error.Type Error.Message object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AuthenticationError(string) Initializes a new instance of the AuthenticationError class. public AuthenticationError(string message) Parameters message string The error message."
+ "summary": "Class AuthenticationError Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents an authentication_error response from the Anthropic API. public class AuthenticationError : Error Inheritance object Error AuthenticationError Inherited Members Error.Type Error.Message object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AuthenticationError(string) Initializes a new instance of the AuthenticationError class. public AuthenticationError(string message) Parameters message string The error message."
},
"api/AnthropicClient.Models.AutoToolChoice.html": {
"href": "api/AnthropicClient.Models.AutoToolChoice.html",
"title": "Class AutoToolChoice | AnthropicClient",
- "keywords": "Class AutoToolChoice Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents the auto tool choice mode. public class AutoToolChoice : ToolChoice Inheritance object ToolChoice AutoToolChoice Inherited Members ToolChoice.Type object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AutoToolChoice() Initializes a new instance of the AutoToolChoice class. public AutoToolChoice()"
+ "summary": "Class AutoToolChoice Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents the auto tool choice mode. public class AutoToolChoice : ToolChoice Inheritance object ToolChoice AutoToolChoice Inherited Members ToolChoice.Type object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors AutoToolChoice() Initializes a new instance of the AutoToolChoice class. public AutoToolChoice()"
},
"api/AnthropicClient.Models.BaseMessageRequest.html": {
"href": "api/AnthropicClient.Models.BaseMessageRequest.html",
"title": "Class BaseMessageRequest | AnthropicClient",
- "keywords": "Class BaseMessageRequest Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents a message request. public abstract class BaseMessageRequest Inheritance object BaseMessageRequest Derived MessageRequest StreamMessageRequest Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors BaseMessageRequest(string, List, int, string?, Dictionary?, decimal, int?, decimal?, ToolChoice?, List?, bool, List?, List?) Initializes a new instance of the BaseMessageRequest class. protected BaseMessageRequest(string model, List messages, int maxTokens, string? system, Dictionary? metadata, decimal temperature, int? topK, decimal? topP, ToolChoice? toolChoice, List? tools, bool stream, List? stopSequences, List? systemMessages) Parameters model string The model ID to use for the request. messages List The messages to send to the model. maxTokens int The maximum number of tokens to generate. system string The system prompt to use for the request. metadata Dictionary The metadata to include with the request. temperature decimal The temperature to use for the request. topK int? The top-K value to use for the request. topP decimal? The top-P value to use for the request. toolChoice ToolChoice The tool choice mode to use for the request. tools List The tools to use for the request. stream bool A value indicating whether the message should be streamed. stopSequences List The prompt stop sequences. systemMessages List The system messages to use for the request. Exceptions ArgumentNullException Thrown when the model or messages is null. ArgumentException Thrown when the messages contain no messages. ArgumentException Thrown when the max tokens is less than one. ArgumentException Thrown when the temperature is less than zero or greater than one. Properties MaxTokens Gets the maximum number of tokens to generate. [JsonPropertyName(\"max_tokens\")] public int MaxTokens { get; init; } Property Value int Messages Gets the messages to send to the model. public List Messages { get; init; } Property Value List Metadata Gets the metadata to include with the request. public Dictionary? Metadata { get; init; } Property Value Dictionary Model Gets the model ID to use for the request. public string Model { get; init; } Property Value string StopSequences Gets the prompt stop sequences. [JsonPropertyName(\"stop_sequences\")] public List StopSequences { get; init; } Property Value List Stream Gets a value indicating whether the message should be streamed. public bool Stream { get; init; } Property Value bool System Gets the system message that will be used as the system prompt if no system messages are provided. [JsonIgnore] public string? System { get; init; } Property Value string SystemMessages Gets the system messages to send to the model to be used as the system prompt. [JsonIgnore] public List? SystemMessages { get; init; } Property Value List SystemPrompt Gets the system prompt that will be used for the request. If will return the system messages if they are provided, otherwise it will return the system message. If neither are provided, it will return null. [JsonPropertyName(\"system\")] public List? SystemPrompt { get; } Property Value List Temperature Gets the temperature to use for the request. public decimal Temperature { get; init; } Property Value decimal ToolChoice Gets the tool choice mode to use for the request. [JsonPropertyName(\"tool_choice\")] public ToolChoice? ToolChoice { get; init; } Property Value ToolChoice Tools Gets the tools to use for the request. public List? Tools { get; init; } Property Value List TopK Gets the top-K value to use for the request. public int? TopK { get; init; } Property Value int? TopP Gets the top-P value to use for the request. public decimal? TopP { get; init; } Property Value decimal?"
+ "summary": "Class BaseMessageRequest Namespace AnthropicClient.Models Assembly AnthropicClient.dll Represents a message request. public abstract class BaseMessageRequest Inheritance object BaseMessageRequest Derived MessageRequest StreamMessageRequest Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors BaseMessageRequest(string, List, int, string?, Dictionary?, decimal, int?, decimal?, ToolChoice?, List?, bool, List?, List?) Initializes a new instance of the BaseMessageRequest class. protected BaseMessageRequest(string model, List messages, int maxTokens, string? system, Dictionary? metadata, decimal temperature, int? topK, decimal? topP, ToolChoice? toolChoice, List? tools, bool stream, List? stopSequences, List? systemMessages) Parameters model string The model ID to use for the request. messages List The messages to send to the model. maxTokens int The maximum number of tokens to generate. system string The system prompt to use for the request. metadata Dictionary The metadata to include with the request. temperature decimal The temperature to use for the request. topK int? The top-K value to use for the request. topP decimal? The top-P value to use for the request. toolChoice ToolChoice The tool choice mode to use for the request. tools List The tools to use for the request. stream bool A value indicating whether the message should be streamed. stopSequences List The prompt stop sequences. systemMessages List The system messages to use for the request. Exceptions ArgumentNullException Thrown when the model or messages is null. ArgumentException Thrown when the messages contain no messages. ArgumentException Thrown when the max tokens is less than one. ArgumentException Thrown when the temperature is less than zero or greater than one. Properties MaxTokens Gets the maximum number of tokens to generate. [JsonPropertyName(\"max_tokens\")] public int MaxTokens { get; init; } Property Value int Messages Gets the messages to send to the model. public List Messages { get; init; } Property Value List Metadata Gets the metadata to include with the request. public Dictionary? Metadata { get; init; } Property Value Dictionary Model Gets the model ID to use for the request. public string Model { get; init; } Property Value string StopSequences Gets the prompt stop sequences. [JsonPropertyName(\"stop_sequences\")] public List StopSequences { get; init; } Property Value List Stream Gets a value indicating whether the message should be streamed. public bool Stream { get; init; } Property Value bool System Gets the system message that will be used as the system prompt if no system messages are provided. [JsonIgnore] public string? System { get; init; } Property Value string SystemMessages Gets the system messages to send to the model to be used as the system prompt. [JsonIgnore] public List? SystemMessages { get; init; } Property Value List SystemPrompt Gets the system prompt that will be used for the request. If will return the system messages if they are provided, otherwise it will return the system message. If neither are provided, it will return null. [JsonPropertyName(\"system\")] public List