Stevan/anthropic-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: documentation for v0.1.0 [skip ci]

Browse Source
This commit is contained in:
Stevan Freeborn
2024-08-18 20:02:24 +00:00
parent 838e7ba859
commit a4a3379dc4
20 changed files with 1745 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/AnthropicClient.Models.BaseMessageRequest.html
+90 -18
View File
@@ -162,9 +162,9 @@ Class BaseMessageRequest <a class="header-action link-secondary" title="View so
<a id="AnthropicClient_Models_BaseMessageRequest__ctor_" data-uid="AnthropicClient.Models.BaseMessageRequest.#ctor*"></a>
<h3 id="AnthropicClient_Models_BaseMessageRequest__ctor_System_String_System_Collections_Generic_List_AnthropicClient_Models_Message__System_Int32_System_String_System_Collections_Generic_Dictionary_System_String_System_Object__System_Decimal_System_Nullable_System_Int32__System_Nullable_System_Decimal__AnthropicClient_Models_ToolChoice_System_Collections_Generic_List_AnthropicClient_Models_Tool__System_Boolean_System_Collections_Generic_List_System_String__" data-uid="AnthropicClient.Models.BaseMessageRequest.#ctor(System.String,System.Collections.Generic.List{AnthropicClient.Models.Message},System.Int32,System.String,System.Collections.Generic.Dictionary{System.String,System.Object},System.Decimal,System.Nullable{System.Int32},System.Nullable{System.Decimal},AnthropicClient.Models.ToolChoice,System.Collections.Generic.List{AnthropicClient.Models.Tool},System.Boolean,System.Collections.Generic.List{System.String})">
BaseMessageRequest(string, List&lt;Message&gt;, int, string?, Dictionary&lt;string, object&gt;?, decimal, int?, decimal?, ToolChoice?, List&lt;Tool&gt;?, bool, List&lt;string&gt;?)
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L99"><i class="bi bi-code-slash"></i></a>
<h3 id="AnthropicClient_Models_BaseMessageRequest__ctor_System_String_System_Collections_Generic_List_AnthropicClient_Models_Message__System_Int32_System_String_System_Collections_Generic_Dictionary_System_String_System_Object__System_Decimal_System_Nullable_System_Int32__System_Nullable_System_Decimal__AnthropicClient_Models_ToolChoice_System_Collections_Generic_List_AnthropicClient_Models_Tool__System_Boolean_System_Collections_Generic_List_System_String__System_Collections_Generic_List_AnthropicClient_Models_TextContent__" data-uid="AnthropicClient.Models.BaseMessageRequest.#ctor(System.String,System.Collections.Generic.List{AnthropicClient.Models.Message},System.Int32,System.String,System.Collections.Generic.Dictionary{System.String,System.Object},System.Decimal,System.Nullable{System.Int32},System.Nullable{System.Decimal},AnthropicClient.Models.ToolChoice,System.Collections.Generic.List{AnthropicClient.Models.Tool},System.Boolean,System.Collections.Generic.List{System.String},System.Collections.Generic.List{AnthropicClient.Models.TextContent})">
BaseMessageRequest(string, List&lt;Message&gt;, int, string?, Dictionary&lt;string, object&gt;?, decimal, int?, decimal?, ToolChoice?, List&lt;Tool&gt;?, bool, List&lt;string&gt;?, List&lt;TextContent&gt;?)
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L135"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="AnthropicClient.Models.BaseMessageRequest.html">BaseMessageRequest</a> class.</p>
@@ -172,7 +172,7 @@ Class BaseMessageRequest <a class="header-action link-secondary" title="View so
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected BaseMessageRequest(string model, List&lt;Message&gt; messages, int maxTokens = 1024, string? system = null, Dictionary&lt;string, object&gt;? metadata = null, decimal temperature = 0.0, int? topK = null, decimal? topP = null, ToolChoice? toolChoice = null, List&lt;Tool&gt;? tools = null, bool stream = false, List&lt;string&gt;? stopSequences = null)</code></pre>
<pre><code class="lang-csharp hljs">protected BaseMessageRequest(string model, List&lt;Message&gt; messages, int maxTokens, string? system, Dictionary&lt;string, object&gt;? metadata, decimal temperature, int? topK, decimal? topP, ToolChoice? toolChoice, List&lt;Tool&gt;? tools, bool stream, List&lt;string&gt;? stopSequences, List&lt;TextContent&gt;? systemMessages)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -187,7 +187,7 @@ Class BaseMessageRequest <a class="header-action link-secondary" title="View so
<dd><p>The maximum number of tokens to generate.</p>
</dd>
<dt><code>system</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The system ID to use for the request.</p>
<dd><p>The system prompt to use for the request.</p>
</dd>
<dt><code>metadata</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd><p>The metadata to include with the request.</p>
@@ -212,6 +212,9 @@ Class BaseMessageRequest <a class="header-action link-secondary" title="View so
</dd>
<dt><code>stopSequences</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>The prompt stop sequences.</p>
</dd>
<dt><code>systemMessages</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="AnthropicClient.Models.TextContent.html">TextContent</a>&gt;</dt>
<dd><p>The system messages to use for the request.</p>
</dd>
</dl>
@@ -252,7 +255,7 @@ Class BaseMessageRequest <a class="header-action link-secondary" title="View so
<h3 id="AnthropicClient_Models_BaseMessageRequest_MaxTokens" data-uid="AnthropicClient.Models.BaseMessageRequest.MaxTokens">
MaxTokens
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L30"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L65"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the maximum number of tokens to generate.</p>
@@ -285,7 +288,7 @@ public int MaxTokens { get; init; }</code></pre>
<h3 id="AnthropicClient_Models_BaseMessageRequest_Messages" data-uid="AnthropicClient.Models.BaseMessageRequest.Messages">
Messages
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L25"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L60"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the messages to send to the model.</p>
@@ -317,7 +320,7 @@ public int MaxTokens { get; init; }</code></pre>
<h3 id="AnthropicClient_Models_BaseMessageRequest_Metadata" data-uid="AnthropicClient.Models.BaseMessageRequest.Metadata">
Metadata
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L36"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L71"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the metadata to include with the request.</p>
@@ -381,7 +384,7 @@ public int MaxTokens { get; init; }</code></pre>
<h3 id="AnthropicClient_Models_BaseMessageRequest_StopSequences" data-uid="AnthropicClient.Models.BaseMessageRequest.StopSequences">
StopSequences
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L41"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L76"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the prompt stop sequences.</p>
@@ -414,7 +417,7 @@ public List&lt;string&gt; StopSequences { get; init; }</code></pre>
<h3 id="AnthropicClient_Models_BaseMessageRequest_Stream" data-uid="AnthropicClient.Models.BaseMessageRequest.Stream">
Stream
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L73"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L108"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets a value indicating whether the message should be streamed.</p>
@@ -446,15 +449,16 @@ public List&lt;string&gt; StopSequences { get; init; }</code></pre>
<h3 id="AnthropicClient_Models_BaseMessageRequest_System" data-uid="AnthropicClient.Models.BaseMessageRequest.System">
System
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L20"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L25"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the system prompt to use for the request.</p>
<div class="markdown level1 summary"><p>Gets the system message that will be used as the system prompt if no system messages are provided.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? System { get; init; }</code></pre>
<pre><code class="lang-csharp hljs">[JsonIgnore]
public string? System { get; init; }</code></pre>
</div>
@@ -474,11 +478,79 @@ public List&lt;string&gt; StopSequences { get; init; }</code></pre>
<a id="AnthropicClient_Models_BaseMessageRequest_SystemMessages_" data-uid="AnthropicClient.Models.BaseMessageRequest.SystemMessages*"></a>
<h3 id="AnthropicClient_Models_BaseMessageRequest_SystemMessages" data-uid="AnthropicClient.Models.BaseMessageRequest.SystemMessages">
SystemMessages
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L31"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the system messages to send to the model to be used as the system prompt.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonIgnore]
public List&lt;TextContent&gt;? SystemMessages { get; init; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="AnthropicClient.Models.TextContent.html">TextContent</a>&gt;</dt>
<dd></dd>
</dl>
<a id="AnthropicClient_Models_BaseMessageRequest_SystemPrompt_" data-uid="AnthropicClient.Models.BaseMessageRequest.SystemPrompt*"></a>
<h3 id="AnthropicClient_Models_BaseMessageRequest_SystemPrompt" data-uid="AnthropicClient.Models.BaseMessageRequest.SystemPrompt">
SystemPrompt
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L39"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>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.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonPropertyName(&quot;system&quot;)]
public List&lt;TextContent&gt;? SystemPrompt { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="AnthropicClient.Models.TextContent.html">TextContent</a>&gt;</dt>
<dd></dd>
</dl>
<a id="AnthropicClient_Models_BaseMessageRequest_Temperature_" data-uid="AnthropicClient.Models.BaseMessageRequest.Temperature*"></a>
<h3 id="AnthropicClient_Models_BaseMessageRequest_Temperature" data-uid="AnthropicClient.Models.BaseMessageRequest.Temperature">
Temperature
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L47"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L82"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the temperature to use for the request.</p>
@@ -510,7 +582,7 @@ public List&lt;string&gt; StopSequences { get; init; }</code></pre>
<h3 id="AnthropicClient_Models_BaseMessageRequest_ToolChoice" data-uid="AnthropicClient.Models.BaseMessageRequest.ToolChoice">
ToolChoice
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L62"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L97"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the tool choice mode to use for the request.</p>
@@ -543,7 +615,7 @@ public ToolChoice? ToolChoice { get; init; }</code></pre>
<h3 id="AnthropicClient_Models_BaseMessageRequest_Tools" data-uid="AnthropicClient.Models.BaseMessageRequest.Tools">
Tools
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L68"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L103"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the tools to use for the request.</p>
@@ -575,7 +647,7 @@ public ToolChoice? ToolChoice { get; init; }</code></pre>
<h3 id="AnthropicClient_Models_BaseMessageRequest_TopK" data-uid="AnthropicClient.Models.BaseMessageRequest.TopK">
TopK
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L52"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L87"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the top-K value to use for the request.</p>
@@ -607,7 +679,7 @@ public ToolChoice? ToolChoice { get; init; }</code></pre>
<h3 id="AnthropicClient_Models_BaseMessageRequest_TopP" data-uid="AnthropicClient.Models.BaseMessageRequest.TopP">
TopP
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L57"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L92"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the top-P value to use for the request.</p>