2024-07-07 16:16:55 -05:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>Interface ITool | AnthropicClient </title>
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
<meta name="title" content="Interface ITool | AnthropicClient ">
|
|
|
|
|
|
|
|
|
|
<meta name="description" content="Interface that a class can implement to be used to create a tool.">
|
|
|
|
|
<link rel="icon" href="../favicon.ico">
|
|
|
|
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
|
|
|
|
<link rel="stylesheet" href="../public/main.css">
|
|
|
|
|
<meta name="docfx:navrel" content="../toc.html">
|
|
|
|
|
<meta name="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
|
|
<meta name="docfx:rel" content="../">
|
|
|
|
|
|
|
|
|
|
|
2024-07-07 16:46:36 -05:00
|
|
|
<meta name="docfx:docurl" content="https://github.com/StevanFreeborn/anthropic-client/new/main/apiSpec/new?filename=AnthropicClient_Models_ITool.md&value=---%0Auid%3A%20AnthropicClient.Models.ITool%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
|
2024-07-07 16:16:55 -05:00
|
|
|
<meta name="loc:inThisArticle" content="In this article">
|
|
|
|
|
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
|
|
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
|
|
|
<meta name="loc:tocFilter" content="Filter by title">
|
|
|
|
|
<meta name="loc:nextArticle" content="Next">
|
|
|
|
|
<meta name="loc:prevArticle" content="Previous">
|
|
|
|
|
<meta name="loc:themeLight" content="Light">
|
|
|
|
|
<meta name="loc:themeDark" content="Dark">
|
|
|
|
|
<meta name="loc:themeAuto" content="Auto">
|
|
|
|
|
<meta name="loc:changeTheme" content="Change theme">
|
|
|
|
|
<meta name="loc:copy" content="Copy">
|
|
|
|
|
<meta name="loc:downloadPdf" content="Download PDF">
|
|
|
|
|
|
|
|
|
|
<script type="module" src="./../public/docfx.min.js"></script>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
const theme = localStorage.getItem('theme') || 'auto'
|
|
|
|
|
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
|
|
|
|
<header class="bg-body border-bottom">
|
|
|
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
|
|
|
<div class="container-xxl flex-nowrap">
|
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
|
|
|
<img id="logo" class="svg" src="../logo.svg" alt="AnthropicClient">
|
|
|
|
|
AnthropicClient
|
|
|
|
|
</a>
|
|
|
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
|
|
|
<i class="bi bi-three-dots"></i>
|
|
|
|
|
</button>
|
|
|
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
|
|
|
<div id="navbar">
|
|
|
|
|
<form class="search" role="search" id="search">
|
|
|
|
|
<i class="bi bi-search"></i>
|
|
|
|
|
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
|
|
|
|
|
</form>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</nav>
|
|
|
|
|
</header>
|
|
|
|
|
|
|
|
|
|
<main class="container-xxl">
|
|
|
|
|
<div class="toc-offcanvas">
|
|
|
|
|
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
|
|
|
|
<div class="offcanvas-header">
|
|
|
|
|
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
|
|
|
|
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="offcanvas-body">
|
|
|
|
|
<nav class="toc" id="toc"></nav>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="content">
|
|
|
|
|
<div class="actionbar">
|
|
|
|
|
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
|
|
|
|
<i class="bi bi-list"></i>
|
|
|
|
|
</button>
|
|
|
|
|
|
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<article data-uid="AnthropicClient.Models.ITool">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1 id="AnthropicClient_Models_ITool" data-uid="AnthropicClient.Models.ITool" class="text-break">
|
2024-07-07 16:46:36 -05:00
|
|
|
Interface ITool <a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/Tool.cs/#L13"><i class="bi bi-code-slash"></i></a>
|
2024-07-07 16:16:55 -05:00
|
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
<div class="facts text-secondary">
|
|
|
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="AnthropicClient.html">AnthropicClient</a>.<a class="xref" href="AnthropicClient.Models.html">Models</a></dd></dl>
|
|
|
|
|
<dl><dt>Assembly</dt><dd>AnthropicClient.dll</dd></dl>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="markdown summary"><p>Interface that a class can implement to be used to create a tool.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="markdown conceptual"></div>
|
|
|
|
|
|
|
|
|
|
<div class="codewrapper">
|
|
|
|
|
<pre><code class="lang-csharp hljs">public interface ITool</code></pre>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="AnthropicClient_Models_ITool_Description_" data-uid="AnthropicClient.Models.ITool.Description*"></a>
|
|
|
|
|
|
|
|
|
|
<h3 id="AnthropicClient_Models_ITool_Description" data-uid="AnthropicClient.Models.ITool.Description">
|
|
|
|
|
Description
|
2024-07-07 16:46:36 -05:00
|
|
|
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/Tool.cs/#L23"><i class="bi bi-code-slash"></i></a>
|
2024-07-07 16:16:55 -05:00
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div class="markdown level1 summary"><p>Gets the description of the tool. Should not be null or empty.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
|
|
|
|
|
|
<div class="codewrapper">
|
|
|
|
|
<pre><code class="lang-csharp hljs">string Description { 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.string">string</a></dt>
|
|
|
|
|
<dd></dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="AnthropicClient_Models_ITool_Function_" data-uid="AnthropicClient.Models.ITool.Function*"></a>
|
|
|
|
|
|
|
|
|
|
<h3 id="AnthropicClient_Models_ITool_Function" data-uid="AnthropicClient.Models.ITool.Function">
|
|
|
|
|
Function
|
2024-07-07 16:46:36 -05:00
|
|
|
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/Tool.cs/#L28"><i class="bi bi-code-slash"></i></a>
|
2024-07-07 16:16:55 -05:00
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div class="markdown level1 summary"><p>Gets the input schema of the tool. Should not be null.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
|
|
|
|
|
|
<div class="codewrapper">
|
|
|
|
|
<pre><code class="lang-csharp hljs">MethodInfo Function { 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.reflection.methodinfo">MethodInfo</a></dt>
|
|
|
|
|
<dd></dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="AnthropicClient_Models_ITool_Name_" data-uid="AnthropicClient.Models.ITool.Name*"></a>
|
|
|
|
|
|
|
|
|
|
<h3 id="AnthropicClient_Models_ITool_Name" data-uid="AnthropicClient.Models.ITool.Name">
|
|
|
|
|
Name
|
2024-07-07 16:46:36 -05:00
|
|
|
<a class="header-action link-secondary" title="View source" href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/Tool.cs/#L18"><i class="bi bi-code-slash"></i></a>
|
2024-07-07 16:16:55 -05:00
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div class="markdown level1 summary"><p>Gets the name of the tool. Should not be null or empty.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
|
|
|
|
|
|
<div class="codewrapper">
|
|
|
|
|
<pre><code class="lang-csharp hljs">string Name { 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.string">string</a></dt>
|
|
|
|
|
<dd></dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
|
|
|
|
<div class="contribution d-print-none">
|
2024-07-07 16:46:36 -05:00
|
|
|
<a href="https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/Tool.cs/#L13" class="edit-link">Edit this page</a>
|
2024-07-07 16:16:55 -05:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="affix">
|
|
|
|
|
<nav id="affix"></nav>
|
|
|
|
|
</div>
|
|
|
|
|
</main>
|
|
|
|
|
|
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
|
|
|
|
|
|
<footer class="border-top text-secondary">
|
|
|
|
|
<div class="container-xxl">
|
|
|
|
|
<div class="flex-fill">
|
|
|
|
|
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</footer>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
