dotnet-api-docs/xml/Microsoft.Extensions.AI.Evaluation.Quality/CompletenessEvaluatorContext.xml at 800c0bf33bcade636fdbf4d04617d0ddd8b75d12 · dotnet/dotnet-api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<Type Name="CompletenessEvaluatorContext" FullName="Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext">
  <TypeSignature Language="C#" Value="public sealed class CompletenessEvaluatorContext : Microsoft.Extensions.AI.Evaluation.EvaluationContext" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CompletenessEvaluatorContext extends Microsoft.Extensions.AI.Evaluation.EvaluationContext" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class CompletenessEvaluatorContext&#xA;Inherits EvaluationContext" />
  <TypeSignature Language="F#" Value="type CompletenessEvaluatorContext = class&#xA;    inherit EvaluationContext" />
  <TypeSignature Language="C++ CLI" Value="public ref class CompletenessEvaluatorContext sealed : Microsoft::Extensions::AI::Evaluation::EvaluationContext" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
    <AssemblyVersion>9.4.0.0</AssemblyVersion>
    <AssemblyVersion>9.5.0.0</AssemblyVersion>
    <AssemblyVersion>9.6.0.0</AssemblyVersion>
    <AssemblyVersion>9.7.0.0</AssemblyVersion>
    <AssemblyVersion>9.9.0.0</AssemblyVersion>
    <AssemblyVersion>9.10.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.1.0.0</AssemblyVersion>
    <AssemblyVersion>10.2.0.0</AssemblyVersion>
    <AssemblyVersion>10.3.0.0</AssemblyVersion>
    <AssemblyVersion>10.4.0.0</AssemblyVersion>
    <AssemblyVersion>10.6.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.Extensions.AI.Evaluation.EvaluationContext</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute FrameworkAlternate="net-10.0-pp;net-11.0-pp;net-8.0-pp;net-9.0-pp">
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <param name="groundTruth">
            The ground truth against which the response that is being evaluated is assessed.
            </param>
    <summary>
            Contextual information that the <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> uses to evaluate the 'Completeness' of a
            response.
            </summary>
    <remarks>
      <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> measures an AI system's ability to deliver comprehensive and accurate
            responses. It assesses how thoroughly the response aligns with the key information, claims, and statements
            established in the supplied <paramref name="groundTruth" />.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CompletenessEvaluatorContext (string groundTruth);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string groundTruth) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (groundTruth As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext : string -&gt; Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext" Usage="new Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext groundTruth" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; CompletenessEvaluatorContext(System::String ^ groundTruth);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
        <AssemblyVersion>10.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="groundTruth" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="groundTruth">
            The ground truth against which the response that is being evaluated is assessed.
            </param>
        <summary>
            Contextual information that the <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> uses to evaluate the 'Completeness' of a
            response.
            </summary>
        <remarks>
          <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> measures an AI system's ability to deliver comprehensive and accurate
            responses. It assesses how thoroughly the response aligns with the key information, claims, and statements
            established in the supplied <paramref name="groundTruth" />.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="GroundTruth">
      <MemberSignature Language="C#" Value="public string GroundTruth { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string GroundTruth" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext.GroundTruth" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property GroundTruth As String" />
      <MemberSignature Language="F#" Value="member this.GroundTruth : string" Usage="Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext.GroundTruth" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ GroundTruth { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
        <AssemblyVersion>10.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the ground truth against which the response that is being evaluated is assessed.
            </summary>
        <value>To be added.</value>
        <remarks>
          <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluator" /> measures an AI system's ability to deliver comprehensive and accurate
            responses. It assesses how thoroughly the response aligns with the key information, claims, and statements
            established in the supplied <see cref="P:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext.GroundTruth" />.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="GroundTruthContextName">
      <MemberSignature Language="C#" Value="public static string GroundTruthContextName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property string GroundTruthContextName" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext.GroundTruthContextName" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property GroundTruthContextName As String" />
      <MemberSignature Language="F#" Value="static member GroundTruthContextName : string" Usage="Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext.GroundTruthContextName" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::String ^ GroundTruthContextName { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.AI.Evaluation.Quality</AssemblyName>
        <AssemblyVersion>10.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the unique <see cref="P:Microsoft.Extensions.AI.Evaluation.EvaluationContext.Name" /> that is used for
            <see cref="T:Microsoft.Extensions.AI.Evaluation.Quality.CompletenessEvaluatorContext" />.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>