docs: documentation for v1.0.0 [skip ci]

2025-07-09 03:15:32 +00:00
parent 47e93c2e93
commit 307c0da0c9
27 changed files with 4747 additions and 313 deletions
@@ -160,11 +160,92 @@ Class DocumentContent  <a class="header-action link-secondary" title="View sourc
 </h2>


+  <a id="AnthropicClient_Models_DocumentContent__ctor_" data-uid="AnthropicClient.Models.DocumentContent.#ctor*"></a>
+
+  <h3 id="AnthropicClient_Models_DocumentContent__ctor_AnthropicClient_Models_Source_" data-uid="AnthropicClient.Models.DocumentContent.#ctor(AnthropicClient.Models.Source)">
+  DocumentContent(Source)
+  <a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/DocumentContent.cs/#L78"><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.DocumentContent.html">DocumentContent</a> class with a document source.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public DocumentContent(Source source)</code></pre>
+  </div>
+
+  <h4 class="section">Parameters</h4>
+  <dl class="parameters">
+    <dt><code>source</code> <a class="xref" href="AnthropicClient.Models.Source.html">Source</a></dt>
+    <dd><p>The document source.</p>
+</dd>
+  </dl>
+
+
+
+
+
+
+
+
+
+  <h4 class="section">Exceptions</h4>
+  <dl class="parameters">
+    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
+    <dd><p>Thrown when the source is null.</p>
+</dd>
+  </dl>
+
+
+
+  <a id="AnthropicClient_Models_DocumentContent__ctor_" data-uid="AnthropicClient.Models.DocumentContent.#ctor*"></a>
+
+  <h3 id="AnthropicClient_Models_DocumentContent__ctor_AnthropicClient_Models_Source_AnthropicClient_Models_CacheControl_" data-uid="AnthropicClient.Models.DocumentContent.#ctor(AnthropicClient.Models.Source,AnthropicClient.Models.CacheControl)">
+  DocumentContent(Source, CacheControl)
+  <a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/DocumentContent.cs/#L92"><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.DocumentContent.html">DocumentContent</a> class with a document source and cache control.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public DocumentContent(Source source, CacheControl cacheControl)</code></pre>
+  </div>
+
+  <h4 class="section">Parameters</h4>
+  <dl class="parameters">
+    <dt><code>source</code> <a class="xref" href="AnthropicClient.Models.Source.html">Source</a></dt>
+    <dd><p>The document source.</p>
+</dd>
+    <dt><code>cacheControl</code> <a class="xref" href="AnthropicClient.Models.CacheControl.html">CacheControl</a></dt>
+    <dd><p>The cache control to be used for the content.</p>
+</dd>
+  </dl>
+
+
+
+
+
+
+
+
+
+  <h4 class="section">Exceptions</h4>
+  <dl class="parameters">
+    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
+    <dd><p>Thrown when the source is null.</p>
+</dd>
+  </dl>
+
+
+
  <a id="AnthropicClient_Models_DocumentContent__ctor_" data-uid="AnthropicClient.Models.DocumentContent.#ctor*"></a>

  <h3 id="AnthropicClient_Models_DocumentContent__ctor_System_String_System_String_" data-uid="AnthropicClient.Models.DocumentContent.#ctor(System.String,System.String)">
  DocumentContent(string, string)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/DocumentContent.cs/#L35"><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/DocumentContent.cs/#L50"><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.DocumentContent.html">DocumentContent</a> class.</p>
@@ -206,7 +287,7 @@ Class DocumentContent  <a class="header-action link-secondary" title="View sourc

  <h3 id="AnthropicClient_Models_DocumentContent__ctor_System_String_System_String_AnthropicClient_Models_CacheControl_" data-uid="AnthropicClient.Models.DocumentContent.#ctor(System.String,System.String,AnthropicClient.Models.CacheControl)">
  DocumentContent(string, string, CacheControl)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/DocumentContent.cs/#L50"><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/DocumentContent.cs/#L65"><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.DocumentContent.html">DocumentContent</a> class.</p>
@@ -251,6 +332,70 @@ Class DocumentContent  <a class="header-action link-secondary" title="View sourc
 </h2>


+  <a id="AnthropicClient_Models_DocumentContent_Citations_" data-uid="AnthropicClient.Models.DocumentContent.Citations*"></a>
+
+  <h3 id="AnthropicClient_Models_DocumentContent_Citations" data-uid="AnthropicClient.Models.DocumentContent.Citations">
+  Citations
+  <a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/DocumentContent.cs/#L30"><i class="bi bi-code-slash"></i></a>
+  </h3>
+
+  <div class="markdown level1 summary"><p>Gets whether citations are enabled for the document.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public CitationOption? Citations { get; init; }</code></pre>
+  </div>
+
+
+
+
+
+  <h4 class="section">Property Value</h4>
+  <dl class="parameters">
+    <dt><a class="xref" href="AnthropicClient.Models.CitationOption.html">CitationOption</a></dt>
+    <dd></dd>
+  </dl>
+
+
+
+
+
+
+
+
+  <a id="AnthropicClient_Models_DocumentContent_Context_" data-uid="AnthropicClient.Models.DocumentContent.Context*"></a>
+
+  <h3 id="AnthropicClient_Models_DocumentContent_Context" data-uid="AnthropicClient.Models.DocumentContent.Context">
+  Context
+  <a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/DocumentContent.cs/#L25"><i class="bi bi-code-slash"></i></a>
+  </h3>
+
+  <div class="markdown level1 summary"><p>Gets the context of the document.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public string? Context { 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.string">string</a></dt>
+    <dd></dd>
+  </dl>
+
+
+
+
+
+
+
+
  <a id="AnthropicClient_Models_DocumentContent_Source_" data-uid="AnthropicClient.Models.DocumentContent.Source*"></a>

  <h3 id="AnthropicClient_Models_DocumentContent_Source" data-uid="AnthropicClient.Models.DocumentContent.Source">
@@ -263,7 +408,7 @@ Class DocumentContent  <a class="header-action link-secondary" title="View sourc
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public DocumentSource Source { get; init; }</code></pre>
+    <pre><code class="lang-csharp hljs">public Source Source { get; init; }</code></pre>
  </div>


@@ -272,7 +417,39 @@ Class DocumentContent  <a class="header-action link-secondary" title="View sourc

  <h4 class="section">Property Value</h4>
  <dl class="parameters">
-    <dt><a class="xref" href="AnthropicClient.Models.DocumentSource.html">DocumentSource</a></dt>
+    <dt><a class="xref" href="AnthropicClient.Models.Source.html">Source</a></dt>
+    <dd></dd>
+  </dl>
+
+
+
+
+
+
+
+
+  <a id="AnthropicClient_Models_DocumentContent_Title_" data-uid="AnthropicClient.Models.DocumentContent.Title*"></a>
+
+  <h3 id="AnthropicClient_Models_DocumentContent_Title" data-uid="AnthropicClient.Models.DocumentContent.Title">
+  Title
+  <a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/DocumentContent.cs/#L20"><i class="bi bi-code-slash"></i></a>
+  </h3>
+
+  <div class="markdown level1 summary"><p>Gets the title of the document.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public string? Title { 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.string">string</a></dt>
    <dd></dd>
  </dl>