ContentHarmEvaluator.xml

<Type Name="ContentHarmEvaluator" FullName="Microsoft.Extensions.AI.Evaluation.Safety.ContentHarmEvaluator">
  <TypeSignature Language="C#" Value="public abstract class ContentHarmEvaluator : Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ContentHarmEvaluator extends Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentHarmEvaluator" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class ContentHarmEvaluator&#xA;Inherits ContentSafetyEvaluator" />
  <TypeSignature Language="F#" Value="type ContentHarmEvaluator = class&#xA;    inherit ContentSafetyEvaluator" />
  <TypeSignature Language="C++ CLI" Value="public ref class ContentHarmEvaluator abstract : Microsoft::Extensions::AI::Evaluation::Safety::ContentSafetyEvaluator" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.AI.Evaluation.Safety</AssemblyName>
    <AssemblyVersion>9.4.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute FrameworkAlternate="net-10.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="contentSafetyServiceConfiguration">
            Specifies the Azure AI project that should be used and credentials that should be used when this
            <see cref="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" /> communicates with the Azure AI Content Safety service to perform evaluations.
            </param>
    <param name="contentSafetyServiceMetricName">
            The name of the metric that should be used when this <see cref="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" /> communicates with the
            Azure AI Content Safety service to perform evaluations.
            </param>
    <param name="metricName">
            The name of the <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" /> produced by this <see cref="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" />.
            </param>
    <param name="evaluatorName">The name of the derived <see cref="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" />.</param>
    <summary>
            An <see langword="abstract" /> base class that can be used to implement <see cref="T:Microsoft.Extensions.AI.Evaluation.IEvaluator" />s that utilize the
            Azure AI Content Safety service to evaluate responses produced by an AI model for the presence of a variety of
            harmful content such as violence, hate speech, etc.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ContentHarmEvaluator (Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyServiceConfiguration contentSafetyServiceConfiguration, string contentSafetyServiceMetricName, string metricName, string evaluatorName);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyServiceConfiguration contentSafetyServiceConfiguration, string contentSafetyServiceMetricName, string metricName, string evaluatorName) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.Safety.ContentHarmEvaluator.#ctor(Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyServiceConfiguration,System.String,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New (contentSafetyServiceConfiguration As ContentSafetyServiceConfiguration, contentSafetyServiceMetricName As String, metricName As String, evaluatorName As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Extensions.AI.Evaluation.Safety.ContentHarmEvaluator : Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyServiceConfiguration * string * string * string -&gt; Microsoft.Extensions.AI.Evaluation.Safety.ContentHarmEvaluator" Usage="new Microsoft.Extensions.AI.Evaluation.Safety.ContentHarmEvaluator (contentSafetyServiceConfiguration, contentSafetyServiceMetricName, metricName, evaluatorName)" />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; ContentHarmEvaluator(Microsoft::Extensions::AI::Evaluation::Safety::ContentSafetyServiceConfiguration ^ contentSafetyServiceConfiguration, System::String ^ contentSafetyServiceMetricName, System::String ^ metricName, System::String ^ evaluatorName);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.AI.Evaluation.Safety</AssemblyName>
        <AssemblyVersion>9.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="contentSafetyServiceConfiguration" Type="Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyServiceConfiguration" />
        <Parameter Name="contentSafetyServiceMetricName" Type="System.String" />
        <Parameter Name="metricName" Type="System.String" />
        <Parameter Name="evaluatorName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="contentSafetyServiceConfiguration">
            Specifies the Azure AI project that should be used and credentials that should be used when this
            <see cref="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" /> communicates with the Azure AI Content Safety service to perform evaluations.
            </param>
        <param name="contentSafetyServiceMetricName">
            The name of the metric that should be used when this <see cref="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" /> communicates with the
            Azure AI Content Safety service to perform evaluations.
            </param>
        <param name="metricName">
            The name of the <see cref="T:Microsoft.Extensions.AI.Evaluation.EvaluationMetric" /> produced by this <see cref="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" />.
            </param>
        <param name="evaluatorName">The name of the derived <see cref="T:Microsoft.Extensions.AI.Evaluation.Safety.ContentSafetyEvaluator" />.</param>
        <summary>
            An <see langword="abstract" /> base class that can be used to implement <see cref="T:Microsoft.Extensions.AI.Evaluation.IEvaluator" />s that utilize the
            Azure AI Content Safety service to evaluate responses produced by an AI model for the presence of a variety of
            harmful content such as violence, hate speech, etc.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EvaluateAsync">
      <MemberSignature Language="C#" Value="public override sealed System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt; EvaluateAsync (System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt; messages, Microsoft.Extensions.AI.ChatResponse modelResponse, Microsoft.Extensions.AI.Evaluation.ChatConfiguration? chatConfiguration = default, System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt;? additionalContext = default, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask`1&lt;class Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt; EvaluateAsync(class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.AI.ChatMessage&gt; messages, class Microsoft.Extensions.AI.ChatResponse modelResponse, class Microsoft.Extensions.AI.Evaluation.ChatConfiguration chatConfiguration, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt; additionalContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.Evaluation.Safety.ContentHarmEvaluator.EvaluateAsync(System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.ChatMessage},Microsoft.Extensions.AI.ChatResponse,Microsoft.Extensions.AI.Evaluation.ChatConfiguration,System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.Evaluation.EvaluationContext},System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides NotOverridable Function EvaluateAsync (messages As IEnumerable(Of ChatMessage), modelResponse As ChatResponse, Optional chatConfiguration As ChatConfiguration = Nothing, Optional additionalContext As IEnumerable(Of EvaluationContext) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of EvaluationResult)" />
      <MemberSignature Language="F#" Value="override this.EvaluateAsync : seq&lt;Microsoft.Extensions.AI.ChatMessage&gt; * Microsoft.Extensions.AI.ChatResponse * Microsoft.Extensions.AI.Evaluation.ChatConfiguration * seq&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt; * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt;" Usage="contentHarmEvaluator.EvaluateAsync (messages, modelResponse, chatConfiguration, additionalContext, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.AI.Evaluation.Safety</AssemblyName>
        <AssemblyVersion>9.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.ValueTask&lt;Microsoft.Extensions.AI.Evaluation.EvaluationResult&gt;</ReturnType>
        <Attributes>
          <Attribute FrameworkAlternate="net-10.0-pp">
            <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })]</AttributeName>
            <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })&gt;]</AttributeName>
          </Attribute>
        </Attributes>
      </ReturnValue>
      <Parameters>
        <Parameter Name="messages" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.ChatMessage&gt;" />
        <Parameter Name="modelResponse" Type="Microsoft.Extensions.AI.ChatResponse" />
        <Parameter Name="chatConfiguration" Type="Microsoft.Extensions.AI.Evaluation.ChatConfiguration">
          <Attributes>
            <Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
              <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
              <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
        <Parameter Name="additionalContext" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.AI.Evaluation.EvaluationContext&gt;">
          <Attributes>
            <Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
              <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
              <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="messages">To be added.</param>
        <param name="modelResponse">To be added.</param>
        <param name="chatConfiguration">To be added.</param>
        <param name="additionalContext">To be added.</param>
        <param name="cancellationToken">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="EvaluationMetricNames">
      <MemberSignature Language="C#" Value="public override System.Collections.Generic.IReadOnlyCollection&lt;string&gt; EvaluationMetricNames { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyCollection`1&lt;string&gt; EvaluationMetricNames" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.AI.Evaluation.Safety.ContentHarmEvaluator.EvaluationMetricNames" />
      <MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property EvaluationMetricNames As IReadOnlyCollection(Of String)" />
      <MemberSignature Language="F#" Value="member this.EvaluationMetricNames : System.Collections.Generic.IReadOnlyCollection&lt;string&gt;" Usage="Microsoft.Extensions.AI.Evaluation.Safety.ContentHarmEvaluator.EvaluationMetricNames" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property System::Collections::Generic::IReadOnlyCollection&lt;System::String ^&gt; ^ EvaluationMetricNames { System::Collections::Generic::IReadOnlyCollection&lt;System::String ^&gt; ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.AI.Evaluation.Safety</AssemblyName>
        <AssemblyVersion>9.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IReadOnlyCollection&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
  </Members>
</Type>