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.StreamMessageRequest.html
+14 -5
View File
@@ -128,6 +128,12 @@ Class StreamMessageRequest <a class="header-action link-secondary" title="View
<div>
<a class="xref" href="AnthropicClient.Models.BaseMessageRequest.html#AnthropicClient_Models_BaseMessageRequest_System">BaseMessageRequest.System</a>
</div>
<div>
<a class="xref" href="AnthropicClient.Models.BaseMessageRequest.html#AnthropicClient_Models_BaseMessageRequest_SystemMessages">BaseMessageRequest.SystemMessages</a>
</div>
<div>
<a class="xref" href="AnthropicClient.Models.BaseMessageRequest.html#AnthropicClient_Models_BaseMessageRequest_SystemPrompt">BaseMessageRequest.SystemPrompt</a>
</div>
<div>
<a class="xref" href="AnthropicClient.Models.BaseMessageRequest.html#AnthropicClient_Models_BaseMessageRequest_Messages">BaseMessageRequest.Messages</a>
</div>
@@ -192,9 +198,9 @@ Class StreamMessageRequest <a class="header-action link-secondary" title="View
<a id="AnthropicClient_Models_StreamMessageRequest__ctor_" data-uid="AnthropicClient.Models.StreamMessageRequest.#ctor*"></a>
<h3 id="AnthropicClient_Models_StreamMessageRequest__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_Collections_Generic_List_System_String__" data-uid="AnthropicClient.Models.StreamMessageRequest.#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.Collections.Generic.List{System.String})">
StreamMessageRequest(string, List&lt;Message&gt;, int, string?, Dictionary&lt;string, object&gt;?, decimal, int?, decimal?, ToolChoice?, List&lt;Tool&gt;?, 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/StreamMessageRequest.cs/#L33"><i class="bi bi-code-slash"></i></a>
<h3 id="AnthropicClient_Models_StreamMessageRequest__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_Collections_Generic_List_System_String__System_Collections_Generic_List_AnthropicClient_Models_TextContent__" data-uid="AnthropicClient.Models.StreamMessageRequest.#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.Collections.Generic.List{System.String},System.Collections.Generic.List{AnthropicClient.Models.TextContent})">
StreamMessageRequest(string, List&lt;Message&gt;, int, string?, Dictionary&lt;string, object&gt;?, decimal, int?, decimal?, ToolChoice?, List&lt;Tool&gt;?, 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/StreamMessageRequest.cs/#L34"><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.StreamMessageRequest.html">StreamMessageRequest</a> class.</p>
@@ -202,7 +208,7 @@ Class StreamMessageRequest <a class="header-action link-secondary" title="View
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public StreamMessageRequest(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, List&lt;string&gt;? stopSequences = null)</code></pre>
<pre><code class="lang-csharp hljs">public StreamMessageRequest(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, List&lt;string&gt;? stopSequences = null, List&lt;TextContent&gt;? systemMessages = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -217,7 +223,7 @@ Class StreamMessageRequest <a class="header-action link-secondary" title="View
<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>
@@ -239,6 +245,9 @@ Class StreamMessageRequest <a class="header-action link-secondary" title="View
</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 include with the request.</p>
</dd>
</dl>