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 BaseMessageRequest | AnthropicClient </ title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "title" content = "Class BaseMessageRequest | AnthropicClient " >
< meta name = "description" content = "Represents a message request." >
< 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_BaseMessageRequest.md&value=---%0Auid%3A%20AnthropicClient.Models.BaseMessageRequest%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.BaseMessageRequest" >
< h1 id = "AnthropicClient_Models_BaseMessageRequest" data-uid = "AnthropicClient.Models.BaseMessageRequest" class = "text-break" >
2024-07-07 16:46:36 -05:00
Class BaseMessageRequest < a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L10" >< 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 message request.</ p >
</ div >
< div class = "markdown conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public abstract class BaseMessageRequest</ 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" > BaseMessageRequest</ span ></ div >
</ dd >
</ dl >
< dl class = "typelist derived" >
< dt > Derived</ dt >
< dd >
< div >< a class = "xref" href = "AnthropicClient.Models.MessageRequest.html" > MessageRequest</ a ></ div >
< div >< a class = "xref" href = "AnthropicClient.Models.StreamMessageRequest.html" > StreamMessageRequest</ a ></ 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_BaseMessageRequest__ctor_" data-uid = "AnthropicClient.Models.BaseMessageRequest.#ctor*" ></ a >
2024-08-18 20:02:24 +00:00
< h3 id = "AnthropicClient_Models_BaseMessageRequest__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_Boolean_System_Collections_Generic_List_System_String__System_Collections_Generic_List_AnthropicClient_Models_TextContent__" data-uid = "AnthropicClient.Models.BaseMessageRequest.#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.Boolean,System.Collections.Generic.List{System.String},System.Collections.Generic.List{AnthropicClient.Models.TextContent})" >
BaseMessageRequest(string, List< Message> , int, string?, Dictionary< string, object> ?, decimal, int?, decimal?, ToolChoice?, List< Tool> ?, bool, List< string> ?, List< TextContent> ?)
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L135" >< 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.BaseMessageRequest.html" > BaseMessageRequest</ a > class.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
2024-08-18 20:02:24 +00:00
< pre >< code class = "lang-csharp hljs" > protected BaseMessageRequest(string model, List< Message> messages, int maxTokens, string? system, Dictionary< string, object> ? metadata, decimal temperature, int? topK, decimal? topP, ToolChoice? toolChoice, List< Tool> ? tools, bool stream, List< string> ? stopSequences, List< TextContent> ? systemMessages)</ code ></ pre >
2024-07-07 16:16:55 -05:00
</ div >
< h4 class = "section" > Parameters</ h4 >
< dl class = "parameters" >
< dt >< code > model</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.string" > string</ a ></ dt >
< dd >< p > The model ID to use for the request.</ p >
</ dd >
< dt >< code > messages</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1" > List</ a > < < a class = "xref" href = "AnthropicClient.Models.Message.html" > Message</ a > > </ dt >
< dd >< p > The messages to send to the model.</ p >
</ dd >
< dt >< code > maxTokens</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.int32" > int</ a ></ dt >
< 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 >
2024-08-18 20:02:24 +00:00
< dd >< p > The system prompt to use for the request.</ p >
2024-07-07 16:16:55 -05:00
</ dd >
< dt >< code > metadata</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2" > Dictionary</ a > < < 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 > > </ dt >
< dd >< p > The metadata to include with the request.</ p >
</ dd >
< dt >< code > temperature</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.decimal" > decimal</ a ></ dt >
< dd >< p > The temperature to use for the request.</ p >
</ dd >
< dt >< code > topK</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.int32" > int</ a > ?</ dt >
< dd >< p > The top-K value to use for the request.</ p >
</ dd >
< dt >< code > topP</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.decimal" > decimal</ a > ?</ dt >
< dd >< p > The top-P value to use for the request.</ p >
</ dd >
< dt >< code > toolChoice</ code > < a class = "xref" href = "AnthropicClient.Models.ToolChoice.html" > ToolChoice</ a ></ dt >
< dd >< p > The tool choice mode to use for the request.</ p >
</ dd >
< dt >< code > tools</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1" > List</ a > < < a class = "xref" href = "AnthropicClient.Models.Tool.html" > Tool</ a > > </ dt >
< dd >< p > The tools to use for the request.</ p >
</ dd >
< dt >< code > stream</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.boolean" > bool</ a ></ dt >
< dd >< p > A value indicating whether the message should be streamed.</ p >
2024-07-10 14:00:35 +00:00
</ dd >
< dt >< code > stopSequences</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1" > List</ a > < < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.string" > string</ a > > </ dt >
< dd >< p > The prompt stop sequences.</ p >
2024-08-18 20:02:24 +00:00
</ dd >
< dt >< code > systemMessages</ code > < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1" > List</ a > < < a class = "xref" href = "AnthropicClient.Models.TextContent.html" > TextContent</ a > > </ dt >
< dd >< p > The system messages to use for the request.</ p >
2024-07-07 16:16:55 -05:00
</ 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 the model ID is invalid.</ p >
</ dd >
< dt >< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.argumentnullexception" > ArgumentNullException</ a ></ dt >
< dd >< p > Thrown when the model or messages is null.</ p >
</ dd >
< dt >< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.argumentexception" > ArgumentException</ a ></ dt >
< dd >< p > Thrown when the messages contain no messages.</ p >
</ dd >
< dt >< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.argumentexception" > ArgumentException</ a ></ dt >
< dd >< p > Thrown when the max tokens is less than one.</ p >
</ dd >
< dt >< a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.argumentexception" > ArgumentException</ a ></ dt >
< dd >< p > Thrown when the temperature is less than zero or greater than one.</ p >
</ dd >
</ dl >
< h2 class = "section" id = "properties" > Properties
</ h2 >
< a id = "AnthropicClient_Models_BaseMessageRequest_MaxTokens_" data-uid = "AnthropicClient.Models.BaseMessageRequest.MaxTokens*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_MaxTokens" data-uid = "AnthropicClient.Models.BaseMessageRequest.MaxTokens" >
MaxTokens
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L65" >< 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 maximum number of tokens to generate.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > [JsonPropertyName(" max_tokens" )]
public int MaxTokens { 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.int32" > int</ a ></ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_Messages_" data-uid = "AnthropicClient.Models.BaseMessageRequest.Messages*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_Messages" data-uid = "AnthropicClient.Models.BaseMessageRequest.Messages" >
Messages
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L60" >< 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 messages to send to the model.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public List< Message> Messages { 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.collections.generic.list-1" > List</ a > < < a class = "xref" href = "AnthropicClient.Models.Message.html" > Message</ a > > </ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_Metadata_" data-uid = "AnthropicClient.Models.BaseMessageRequest.Metadata*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_Metadata" data-uid = "AnthropicClient.Models.BaseMessageRequest.Metadata" >
Metadata
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L71" >< 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 metadata to include with the request.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public Dictionary< string, object> ? Metadata { 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.collections.generic.dictionary-2" > Dictionary</ a > < < 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 > > </ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_Model_" data-uid = "AnthropicClient.Models.BaseMessageRequest.Model*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_Model" data-uid = "AnthropicClient.Models.BaseMessageRequest.Model" >
Model
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/BaseMessageRequest.cs/#L15" >< 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 model ID to use for the request.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public string Model { 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_BaseMessageRequest_StopSequences_" data-uid = "AnthropicClient.Models.BaseMessageRequest.StopSequences*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_StopSequences" data-uid = "AnthropicClient.Models.BaseMessageRequest.StopSequences" >
StopSequences
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L76" >< 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 prompt stop sequences.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > [JsonPropertyName(" stop_sequences" )]
public List< string> StopSequences { 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.collections.generic.list-1" > List</ a > < < a class = "xref" href = "https://learn.microsoft.com/dotnet/api/system.string" > string</ a > > </ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_Stream_" data-uid = "AnthropicClient.Models.BaseMessageRequest.Stream*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_Stream" data-uid = "AnthropicClient.Models.BaseMessageRequest.Stream" >
Stream
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L108" >< i class = "bi bi-code-slash" ></ i ></ a >
2024-07-07 16:16:55 -05:00
</ h3 >
< div class = "markdown level1 summary" >< p > Gets a value indicating whether the message should be streamed.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public bool Stream { 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.boolean" > bool</ a ></ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_System_" data-uid = "AnthropicClient.Models.BaseMessageRequest.System*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_System" data-uid = "AnthropicClient.Models.BaseMessageRequest.System" >
System
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L25" >< i class = "bi bi-code-slash" ></ i ></ a >
2024-07-07 16:16:55 -05:00
</ h3 >
2024-08-18 20:02:24 +00:00
< div class = "markdown level1 summary" >< p > Gets the system message that will be used as the system prompt if no system messages are provided.</ p >
2024-07-07 16:16:55 -05:00
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
2024-08-18 20:02:24 +00:00
< pre >< code class = "lang-csharp hljs" > [JsonIgnore]
public string? System { get; init; }</ code ></ pre >
2024-07-07 16:16:55 -05:00
</ 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 >
2024-08-18 20:02:24 +00:00
< a id = "AnthropicClient_Models_BaseMessageRequest_SystemMessages_" data-uid = "AnthropicClient.Models.BaseMessageRequest.SystemMessages*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_SystemMessages" data-uid = "AnthropicClient.Models.BaseMessageRequest.SystemMessages" >
SystemMessages
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L31" >< i class = "bi bi-code-slash" ></ i ></ a >
</ h3 >
< div class = "markdown level1 summary" >< p > Gets the system messages to send to the model to be used as the system prompt.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > [JsonIgnore]
public List< TextContent> ? SystemMessages { 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.collections.generic.list-1" > List</ a > < < a class = "xref" href = "AnthropicClient.Models.TextContent.html" > TextContent</ a > > </ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_SystemPrompt_" data-uid = "AnthropicClient.Models.BaseMessageRequest.SystemPrompt*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_SystemPrompt" data-uid = "AnthropicClient.Models.BaseMessageRequest.SystemPrompt" >
SystemPrompt
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L39" >< i class = "bi bi-code-slash" ></ i ></ a >
</ h3 >
< div class = "markdown level1 summary" >< p > Gets the system prompt that will be used for the request.
If will return the system messages if they are provided, otherwise it will return the system message.
If neither are provided, it will return null.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > [JsonPropertyName(" system" )]
public List< TextContent> ? SystemPrompt { 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.collections.generic.list-1" > List</ a > < < a class = "xref" href = "AnthropicClient.Models.TextContent.html" > TextContent</ a > > </ dt >
< dd ></ dd >
</ dl >
2024-07-07 16:16:55 -05:00
< a id = "AnthropicClient_Models_BaseMessageRequest_Temperature_" data-uid = "AnthropicClient.Models.BaseMessageRequest.Temperature*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_Temperature" data-uid = "AnthropicClient.Models.BaseMessageRequest.Temperature" >
Temperature
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L82" >< 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 temperature to use for the request.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public decimal Temperature { 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.decimal" > decimal</ a ></ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_ToolChoice_" data-uid = "AnthropicClient.Models.BaseMessageRequest.ToolChoice*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_ToolChoice" data-uid = "AnthropicClient.Models.BaseMessageRequest.ToolChoice" >
ToolChoice
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L97" >< 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 choice mode to use for the request.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > [JsonPropertyName(" tool_choice" )]
public ToolChoice? ToolChoice { get; init; }</ code ></ pre >
</ div >
< h4 class = "section" > Property Value</ h4 >
< dl class = "parameters" >
< dt >< a class = "xref" href = "AnthropicClient.Models.ToolChoice.html" > ToolChoice</ a ></ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_Tools_" data-uid = "AnthropicClient.Models.BaseMessageRequest.Tools*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_Tools" data-uid = "AnthropicClient.Models.BaseMessageRequest.Tools" >
Tools
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L103" >< 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 tools to use for the request.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public List< Tool> ? Tools { 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.collections.generic.list-1" > List</ a > < < a class = "xref" href = "AnthropicClient.Models.Tool.html" > Tool</ a > > </ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_TopK_" data-uid = "AnthropicClient.Models.BaseMessageRequest.TopK*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_TopK" data-uid = "AnthropicClient.Models.BaseMessageRequest.TopK" >
TopK
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L87" >< 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 top-K value to use for the request.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public int? TopK { 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.int32" > int</ a > ?</ dt >
< dd ></ dd >
</ dl >
< a id = "AnthropicClient_Models_BaseMessageRequest_TopP_" data-uid = "AnthropicClient.Models.BaseMessageRequest.TopP*" ></ a >
< h3 id = "AnthropicClient_Models_BaseMessageRequest_TopP" data-uid = "AnthropicClient.Models.BaseMessageRequest.TopP" >
TopP
2024-08-18 20:02:24 +00:00
< a class = "header-action link-secondary" title = "View source" href = "https://github.com/StevanFreeborn/anthropic-client/blob/main/src/AnthropicClient/Models/BaseMessageRequest.cs/#L92" >< 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 top-P value to use for the request.</ p >
</ div >
< div class = "markdown level1 conceptual" ></ div >
< div class = "codewrapper" >
< pre >< code class = "lang-csharp hljs" > public decimal? TopP { 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.decimal" > decimal</ 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/BaseMessageRequest.cs/#L10" 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 >
