Files
anthropic-client/docs/api/AnthropicClient.Models.html
T

421 lines
16 KiB
HTML
Raw Normal View History

2024-07-07 16:16:55 -05:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Namespace AnthropicClient.Models | AnthropicClient </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Namespace AnthropicClient.Models | AnthropicClient ">
<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="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<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">
<h1 id="AnthropicClient_Models" data-uid="AnthropicClient.Models" class="text-break">Namespace AnthropicClient.Models</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.AnthropicError.html">AnthropicError</a></dt>
<dd><p>Represents an error response from the Anthropic API.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.AnthropicEvent.html">AnthropicEvent</a></dt>
<dd><p>Represents an event from the Anthropic API.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.AnthropicFunction.html">AnthropicFunction</a></dt>
<dd><p>Represents a function that can be provided as a tool.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.AnthropicHeaders.html">AnthropicHeaders</a></dt>
<dd><p>Represents headers included in Anthropic API responses.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.AnthropicModels.html">AnthropicModels</a></dt>
<dd><p>Provides constants for the Anthropic models.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.AnyToolChoice.html">AnyToolChoice</a></dt>
<dd><p>Represents the any tool choice mode.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ApiError.html">ApiError</a></dt>
<dd><p>Represents an api_error response from the Anthropic API.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.AuthenticationError.html">AuthenticationError</a></dt>
<dd><p>Represents an authentication_error response from the Anthropic API.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.AutoToolChoice.html">AutoToolChoice</a></dt>
<dd><p>Represents the auto tool choice mode.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.BaseMessageRequest.html">BaseMessageRequest</a></dt>
<dd><p>Represents a message request.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.Content.html">Content</a></dt>
<dd><p>Represents part of the content of a message.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ContentDelta.html">ContentDelta</a></dt>
<dd><p>Represents a content delta.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ContentDeltaEventData.html">ContentDeltaEventData</a></dt>
<dd><p>Represents data for a content_block_delta event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ContentDeltaType.html">ContentDeltaType</a></dt>
<dd><p>Provides constants for content delta types.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ContentStartEventData.html">ContentStartEventData</a></dt>
<dd><p>Represents data for a content_block_start event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ContentStopEventData.html">ContentStopEventData</a></dt>
<dd><p>Represents data for a content_block_stop event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ContentType.html">ContentType</a></dt>
<dd><p>Represents the content type.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.Error.html">Error</a></dt>
<dd><p>Represents an error.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ErrorEventData.html">ErrorEventData</a></dt>
<dd><p>Represents data for an error event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ErrorType.html">ErrorType</a></dt>
<dd><p>Represents the error type.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.EventData.html">EventData</a></dt>
<dd><p>Represents data for an event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.EventType.html">EventType</a></dt>
<dd><p>Provides constants for event types.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.FunctionParameterAttribute.html">FunctionParameterAttribute</a></dt>
<dd><p>Attribute to describe a function parameter.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.FunctionPropertyAttribute.html">FunctionPropertyAttribute</a></dt>
<dd><p>Attribute to describe a property of a type that is used as a function parameter.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ImageContent.html">ImageContent</a></dt>
<dd><p>Represents image content that is part of a message.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ImageSource.html">ImageSource</a></dt>
<dd><p>Represents an image source.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ImageType.html">ImageType</a></dt>
<dd><p>Represents the image type.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.InputProperty.html">InputProperty</a></dt>
<dd><p>Represents an input property.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.InputSchema.html">InputSchema</a></dt>
<dd><p>Represents an input schema.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.InvalidRequestError.html">InvalidRequestError</a></dt>
<dd><p>Represents an invalid_request error.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.JsonDelta.html">JsonDelta</a></dt>
<dd><p>Represents a JSON delta.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.Message.html">Message</a></dt>
<dd><p>Represents a message.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.MessageCompleteEventData.html">MessageCompleteEventData</a></dt>
<dd><p>Represents data for the message_complete event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.MessageDelta.html">MessageDelta</a></dt>
<dd><p>Represents a message delta.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.MessageDeltaEventData.html">MessageDeltaEventData</a></dt>
<dd><p>Represents data for a message_delta event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.MessageRequest.html">MessageRequest</a></dt>
<dd><p>Represents a message request.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.MessageResponse.html">MessageResponse</a></dt>
<dd><p>Represents a response.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.MessageRole.html">MessageRole</a></dt>
<dd><p>Represents the message role.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.MessageStartEventData.html">MessageStartEventData</a></dt>
<dd><p>Represents data for a message_start event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.MessageStopEventData.html">MessageStopEventData</a></dt>
<dd><p>Represents data for a message_stop event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.NotFoundError.html">NotFoundError</a></dt>
<dd><p>Represents a not_found error.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.OverloadedError.html">OverloadedError</a></dt>
<dd><p>Represents an overloaded error.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.PermissionError.html">PermissionError</a></dt>
<dd><p>Represents a permission error.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.PingEventData.html">PingEventData</a></dt>
<dd><p>Represents data for a ping event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.RateLimitError.html">RateLimitError</a></dt>
<dd><p>Represents a rate_limit error.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.SpecificToolChoice.html">SpecificToolChoice</a></dt>
<dd><p>Represents the specific tool choice mode.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.StopReasonType.html">StopReasonType</a></dt>
<dd><p>Represents the stop reason type.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.StreamMessageRequest.html">StreamMessageRequest</a></dt>
<dd><p>Represents a message request.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.TextContent.html">TextContent</a></dt>
<dd><p>Represents text content that is part of a message.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.TextDelta.html">TextDelta</a></dt>
<dd><p>Represents a text delta.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.Tool.html">Tool</a></dt>
<dd><p>Represents a tool that can be used.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ToolCall.html">ToolCall</a></dt>
<dd><p>Represents a tool call.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ToolCallResult-1.html">ToolCallResult&lt;T&gt;</a></dt>
<dd><p>Represents a tool call result.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ToolChoice.html">ToolChoice</a></dt>
<dd><p>Represents a tool choice mode.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ToolChoiceType.html">ToolChoiceType</a></dt>
<dd><p>Represents the tool choice type.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ToolResultContent.html">ToolResultContent</a></dt>
<dd><p>Represents tool result content that is part of a message.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ToolUseContent.html">ToolUseContent</a></dt>
<dd><p>Represents tool use content that is part of a message.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.Usage.html">Usage</a></dt>
<dd><p>Represents the usage of a response.</p>
</dd>
</dl>
<h3 id="interfaces">
Interfaces
</h3>
<dl class="jumplist">
<dt><a class="xref" href="AnthropicClient.Models.ITool.html">ITool</a></dt>
<dd><p>Interface that a class can implement to be used to create a tool.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</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>