2024-11-19 20:13:35 +00:00
<!DOCTYPE html>
2024-07-07 16:16:55 -05:00
< html >
< head >
< meta charset = "utf-8" >
< title > Class ToolCall | AnthropicClient </ title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "title" content = "Class ToolCall | AnthropicClient " >
< meta name = "description" content = "Represents a tool call." >
< 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_ToolCall.md&value=---%0Auid%3A%20AnthropicClient.Models.ToolCall%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 >
2024-11-19 20:13:35 +00:00
< input class = "form-control" id = "search-query" type = "search" disabled placeholder = "Search" autocomplete = "off" aria-label = "Search" >
2024-07-07 16:16:55 -05:00
</ 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.ToolCall" >
< h1 id = "AnthropicClient_Models_ToolCall" data-uid = "AnthropicClient.Models.ToolCall" class = "text-break" >
2024-07-07 16:46:36 -05:00
Class ToolCall < a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/ToolCall.cs/#L11" >< 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 > Represents a tool call.</ p >
</ div >
< div class = "markdown conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public class ToolCall</ code ></ pre >
</ div >
< dl class = "typelist inheritance" >
< dt > Inheritance</ dt >
< dd >
< div >< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.object" > object</ a ></ div >
< div >< span class = "xref" > ToolCall</ span ></ div >
</ dd >
</ dl >
< dl class = "typelist inheritedMembers" >
< dt > Inherited Members</ dt >
< dd >
< div >
< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)" > object.Equals(object)</ a >
</ div >
< div >
< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)" > object.Equals(object, object)</ a >
</ div >
< div >
< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.object.gethashcode" > object.GetHashCode()</ a >
</ div >
< div >
< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.object.gettype" > object.GetType()</ a >
</ div >
< div >
< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone" > object.MemberwiseClone()</ a >
</ div >
< div >
< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.object.referenceequals" > object.ReferenceEquals(object, object)</ a >
</ div >
< div >
< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.object.tostring" > object.ToString()</ a >
</ div >
</ dd ></ dl >
< h2 class = "section" id = "constructors" > Constructors
</ h2 >
< a id = "AnthropicClient_Models_ToolCall__ctor_" data-uid = "AnthropicClient.Models.ToolCall.#ctor*" ></ a >
< h3 id = "AnthropicClient_Models_ToolCall__ctor_AnthropicClient_Models_Tool_AnthropicClient_Models_ToolUseContent_" data-uid = "AnthropicClient.Models.ToolCall.#ctor(AnthropicClient.Models.Tool,AnthropicClient.Models.ToolUseContent)" >
ToolCall(Tool, ToolUseContent)
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/ToolCall.cs/#L29" >< i class = "bi bi-code-slash" ></ i ></ a >
2024-07-07 16:16:55 -05:00
</ h3 >
< div class = "markdown level1 summary" >< p > Initializes a new instance of the < a class = "xref" href = "AnthropicClient.Models.ToolCall.html" > ToolCall</ a > class.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public ToolCall(Tool tool, ToolUseContent toolUse)</ code ></ pre >
</ div >
< h4 class = "section" > Parameters</ h4 >
< dl class = "parameters" >
< dt >< code > tool</ code > < a class = "xref" href = "AnthropicClient.Models.Tool.html" > Tool</ a ></ dt >
< dd >< p > The tool of the tool call.</ p >
</ dd >
< dt >< code > toolUse</ code > < a class = "xref" href = "AnthropicClient.Models.ToolUseContent.html" > ToolUseContent</ a ></ dt >
< dd >< p > The tool use of the tool call.</ p >
</ dd >
</ dl >
< h2 class = "section" id = "properties" > Properties
</ h2 >
< a id = "AnthropicClient_Models_ToolCall_Tool_" data-uid = "AnthropicClient.Models.ToolCall.Tool*" ></ a >
< h3 id = "AnthropicClient_Models_ToolCall_Tool" data-uid = "AnthropicClient.Models.ToolCall.Tool" >
Tool
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/ToolCall.cs/#L16" >< 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 tool of the tool call.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public Tool Tool { get; }</ code ></ pre >
</ div >
< h4 class = "section" > Property Value</ h4 >
< dl class = "parameters" >
< dt >< a class = "xref" href = "AnthropicClient.Models.Tool.html" > Tool</ a ></ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_ToolCall_ToolUse_" data-uid = "AnthropicClient.Models.ToolCall.ToolUse*" ></ a >
< h3 id = "AnthropicClient_Models_ToolCall_ToolUse" data-uid = "AnthropicClient.Models.ToolCall.ToolUse" >
ToolUse
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/ToolCall.cs/#L21" >< 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 tool use of the tool call.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public ToolUseContent ToolUse { get; }</ code ></ pre >
</ div >
< h4 class = "section" > Property Value</ h4 >
< dl class = "parameters" >
< dt >< a class = "xref" href = "AnthropicClient.Models.ToolUseContent.html" > ToolUseContent</ a ></ dt >
< dd ></ dd >
</ dl >
< h2 class = "section" id = "methods" > Methods
</ h2 >
< a id = "AnthropicClient_Models_ToolCall_InvokeAsync_" data-uid = "AnthropicClient.Models.ToolCall.InvokeAsync*" ></ a >
< h3 id = "AnthropicClient_Models_ToolCall_InvokeAsync" data-uid = "AnthropicClient.Models.ToolCall.InvokeAsync" >
InvokeAsync()
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/ToolCall.cs/#L39" >< i class = "bi bi-code-slash" ></ i ></ a >
2024-07-07 16:16:55 -05:00
</ h3 >
< div class = "markdown level1 summary" >< p > Invokes the tool call.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public Task< ToolCallResult< object>> InvokeAsync()</ code ></ pre >
</ div >
< h4 class = "section" > Returns</ h4 >
< dl class = "parameters" >
< dt >< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1" > Task</ a > < < a class = "xref" href = "AnthropicClient.Models.ToolCallResult-1.html" > ToolCallResult</ a > < < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.object" > object</ a > >> </ dt >
< dd >< p > The result of the tool call as an instance of < a class = "xref" href = "AnthropicClient.Models.ToolCallResult-1.html" > ToolCallResult< T> </ a > .</ p >
</ dd >
</ dl >
< a id = "AnthropicClient_Models_ToolCall_InvokeAsync_" data-uid = "AnthropicClient.Models.ToolCall.InvokeAsync*" ></ a >
< h3 id = "AnthropicClient_Models_ToolCall_InvokeAsync__1" data-uid = "AnthropicClient.Models.ToolCall.InvokeAsync``1" >
InvokeAsync< T> ()
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/ToolCall.cs/#L51" >< i class = "bi bi-code-slash" ></ i ></ a >
2024-07-07 16:16:55 -05:00
</ h3 >
< div class = "markdown level1 summary" >< p > Invokes the tool call.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public Task< ToolCallResult< T>> InvokeAsync< T> ()</ code ></ pre >
</ div >
< h4 class = "section" > Returns</ h4 >
< dl class = "parameters" >
< dt >< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1" > Task</ a > < < a class = "xref" href = "AnthropicClient.Models.ToolCallResult-1.html" > ToolCallResult</ a > < T>> </ dt >
< dd >< p > The result of the tool call as an instance of < a class = "xref" href = "AnthropicClient.Models.ToolCallResult-1.html" > ToolCallResult< T> </ a > .</ p >
</ dd >
</ dl >
< h4 class = "section" > Type Parameters</ h4 >
< dl class = "parameters" >
< dt >< code > T</ code ></ dt >
< dd >< p > The type of the result value.</ p >
</ dd >
</ dl >
< h4 class = "section" > Exceptions</ h4 >
< dl class = "parameters" >
< dt >< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.argumentexception" > ArgumentException</ a ></ dt >
< dd >< p > Thrown when a parameter name is not found.</ p >
</ dd >
< dt >< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.argumentexception" > ArgumentException</ a ></ dt >
< dd >< p > Thrown when an argument is missing.</ p >
</ 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/ToolCall.cs/#L11" 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 >
