FunctionInvocationContext.xml

<TypeName="FunctionInvocationContext"FullName="Microsoft.Extensions.AI.FunctionInvocationContext">
 <TypeSignatureLanguage="C#"Value="public sealed class FunctionInvocationContext" />
 <TypeSignatureLanguage="ILAsm"Value=".class public auto ansi sealed beforefieldinit FunctionInvocationContext extends System.Object" />
 <TypeSignatureLanguage="DocId"Value="T:Microsoft.Extensions.AI.FunctionInvocationContext" />
 <TypeSignatureLanguage="VB.NET"Value="Public NotInheritable Class FunctionInvocationContext" />
 <TypeSignatureLanguage="F#"Value="type FunctionInvocationContext = class" />
 <TypeSignatureLanguage="C++ CLI"Value="public ref class FunctionInvocationContext sealed" />
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.3.0.0</AssemblyVersion>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Base>
 <BaseTypeName>System.Object</BaseTypeName>
 </Base>
 <Interfaces />
 <Attributes>
 <AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
 <AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
 <AttributeNameLanguage="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
 </Attribute>
 </Attributes>
 <Docs>
 <summary>Provides context for an in-flight function invocation.</summary>
 <remarks>To be added.</remarks>
 </Docs>
 <Members>
 <MemberMemberName=".ctor">
 <MemberSignatureLanguage="C#"Value="public FunctionInvocationContext ();" />
 <MemberSignatureLanguage="ILAsm"Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
 <MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.FunctionInvocationContext.#ctor" />
 <MemberSignatureLanguage="VB.NET"Value="Public Sub New ()" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; FunctionInvocationContext();" />
 <MemberType>Constructor</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Parameters />
 <Docs>
 <summary>Initializes a new instance of the <seecref="T:Microsoft.Extensions.AI.FunctionInvocationContext" /> class.</summary>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="Arguments">
 <MemberSignatureLanguage="C#"Value="public Microsoft.Extensions.AI.AIFunctionArguments Arguments { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance class Microsoft.Extensions.AI.AIFunctionArguments Arguments" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.FunctionInvocationContext.Arguments" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property Arguments As AIFunctionArguments" />
 <MemberSignatureLanguage="F#"Value="member this.Arguments : Microsoft.Extensions.AI.AIFunctionArguments with get, set"Usage="Microsoft.Extensions.AI.FunctionInvocationContext.Arguments" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property Microsoft::Extensions::AI::AIFunctionArguments ^ Arguments { Microsoft::Extensions::AI::AIFunctionArguments ^ get(); void set(Microsoft::Extensions::AI::AIFunctionArguments ^ value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>Microsoft.Extensions.AI.AIFunctionArguments</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>Gets or sets the arguments associated with this invocation.</summary>
 <value>To be added.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="CallContent">
 <MemberSignatureLanguage="C#"Value="public Microsoft.Extensions.AI.FunctionCallContent CallContent { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance class Microsoft.Extensions.AI.FunctionCallContent CallContent" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.FunctionInvocationContext.CallContent" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property CallContent As FunctionCallContent" />
 <MemberSignatureLanguage="F#"Value="member this.CallContent : Microsoft.Extensions.AI.FunctionCallContent with get, set"Usage="Microsoft.Extensions.AI.FunctionInvocationContext.CallContent" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property Microsoft::Extensions::AI::FunctionCallContent ^ CallContent { Microsoft::Extensions::AI::FunctionCallContent ^ get(); void set(Microsoft::Extensions::AI::FunctionCallContent ^ value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>Microsoft.Extensions.AI.FunctionCallContent</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>Gets or sets the function call content information associated with this invocation.</summary>
 <value>To be added.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="Function">
 <MemberSignatureLanguage="C#"Value="public Microsoft.Extensions.AI.AIFunction Function { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance class Microsoft.Extensions.AI.AIFunction Function" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.FunctionInvocationContext.Function" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property Function As AIFunction" />
 <MemberSignatureLanguage="F#"Value="member this.Function : Microsoft.Extensions.AI.AIFunction with get, set"Usage="Microsoft.Extensions.AI.FunctionInvocationContext.Function" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property Microsoft::Extensions::AI::AIFunction ^ Function { Microsoft::Extensions::AI::AIFunction ^ get(); void set(Microsoft::Extensions::AI::AIFunction ^ value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>Microsoft.Extensions.AI.AIFunction</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>Gets or sets the AI function to be invoked.</summary>
 <value>To be added.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="FunctionCallIndex">
 <MemberSignatureLanguage="C#"Value="public int FunctionCallIndex { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance int32 FunctionCallIndex" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.FunctionInvocationContext.FunctionCallIndex" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property FunctionCallIndex As Integer" />
 <MemberSignatureLanguage="F#"Value="member this.FunctionCallIndex : int with get, set"Usage="Microsoft.Extensions.AI.FunctionInvocationContext.FunctionCallIndex" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property int FunctionCallIndex { int get(); void set(int value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Int32</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>Gets or sets the index of the function call within the iteration.</summary>
 <value>To be added.</value>
 <remarks>
 The response from the underlying client may include multiple function call requests.
 This index indicates the position of the function call within the iteration.
 </remarks>
 </Docs>
 </Member>
 <MemberMemberName="FunctionCount">
 <MemberSignatureLanguage="C#"Value="public int FunctionCount { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance int32 FunctionCount" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.FunctionInvocationContext.FunctionCount" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property FunctionCount As Integer" />
 <MemberSignatureLanguage="F#"Value="member this.FunctionCount : int with get, set"Usage="Microsoft.Extensions.AI.FunctionInvocationContext.FunctionCount" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property int FunctionCount { int get(); void set(int value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Int32</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>Gets or sets the total number of function call requests within the iteration.</summary>
 <value>To be added.</value>
 <remarks>
 The response from the underlying client might include multiple function call requests.
 This count indicates how many there were.
 </remarks>
 </Docs>
 </Member>
 <MemberMemberName="Iteration">
 <MemberSignatureLanguage="C#"Value="public int Iteration { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance int32 Iteration" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.FunctionInvocationContext.Iteration" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property Iteration As Integer" />
 <MemberSignatureLanguage="F#"Value="member this.Iteration : int with get, set"Usage="Microsoft.Extensions.AI.FunctionInvocationContext.Iteration" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property int Iteration { int get(); void set(int value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Int32</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>Gets or sets the number of this iteration with the underlying client.</summary>
 <value>To be added.</value>
 <remarks>
 The initial request to the client that passes along the chat contents provided to the <seecref="T:Microsoft.Extensions.AI.FunctionInvokingChatClient" />
 is iteration 1. If the client responds with a function call request, the next request to the client is iteration 2, and so on.
 </remarks>
 </Docs>
 </Member>
 <MemberMemberName="Messages">
 <MemberSignatureLanguage="C#"Value="public System.Collections.Generic.IList&lt;Microsoft.Extensions.AI.ChatMessage&gt; Messages { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance class System.Collections.Generic.IList`1&lt;class Microsoft.Extensions.AI.ChatMessage&gt; Messages" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.FunctionInvocationContext.Messages" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property Messages As IList(Of ChatMessage)" />
 <MemberSignatureLanguage="F#"Value="member this.Messages : System.Collections.Generic.IList&lt;Microsoft.Extensions.AI.ChatMessage&gt; with get, set"Usage="Microsoft.Extensions.AI.FunctionInvocationContext.Messages" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property System::Collections::Generic::IList&lt;Microsoft::Extensions::AI::ChatMessage ^&gt; ^ Messages { System::Collections::Generic::IList&lt;Microsoft::Extensions::AI::ChatMessage ^&gt; ^ get(); void set(System::Collections::Generic::IList&lt;Microsoft::Extensions::AI::ChatMessage ^&gt; ^ value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Collections.Generic.IList&lt;Microsoft.Extensions.AI.ChatMessage&gt;</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>Gets or sets the chat contents associated with the operation that initiated this function call request.</summary>
 <value>To be added.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="Options">
 <MemberSignatureLanguage="C#"Value="public Microsoft.Extensions.AI.ChatOptions? Options { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance class Microsoft.Extensions.AI.ChatOptions Options" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.FunctionInvocationContext.Options" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property Options As ChatOptions" />
 <MemberSignatureLanguage="F#"Value="member this.Options : Microsoft.Extensions.AI.ChatOptions with get, set"Usage="Microsoft.Extensions.AI.FunctionInvocationContext.Options" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property Microsoft::Extensions::AI::ChatOptions ^ Options { Microsoft::Extensions::AI::ChatOptions ^ get(); void set(Microsoft::Extensions::AI::ChatOptions ^ value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Attributes>
 <AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
 <AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
 <AttributeNameLanguage="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
 </Attribute>
 </Attributes>
 <ReturnValue>
 <ReturnType>Microsoft.Extensions.AI.ChatOptions</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>Gets or sets the chat options associated with the operation that initiated this function call request.</summary>
 <value>To be added.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="Terminate">
 <MemberSignatureLanguage="C#"Value="public bool Terminate { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance bool Terminate" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.FunctionInvocationContext.Terminate" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property Terminate As Boolean" />
 <MemberSignatureLanguage="F#"Value="member this.Terminate : bool with get, set"Usage="Microsoft.Extensions.AI.FunctionInvocationContext.Terminate" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property bool Terminate { bool get(); void set(bool value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.AI</AssemblyName>
 <AssemblyVersion>9.4.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Boolean</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>Gets or sets a value indicating whether to terminate the request.</summary>
 <value>To be added.</value>
 <remarks>
 In response to a function call request, the function might be invoked, its result added to the chat contents,
 and a new request issued to the wrapped client. If this property is set to <seelangword="true" />, that subsequent request
 will not be issued and instead the loop immediately terminated rather than continuing until there are no
 more function call requests in responses.
 </remarks>
 </Docs>
 </Member>
 </Members>
</Type>