ExtractiveSummarizeResult.xml

<Type Name="ExtractiveSummarizeResult" FullName="Azure.AI.TextAnalytics.ExtractiveSummarizeResult">
  <TypeSignature Language="C#" Value="public class ExtractiveSummarizeResult : Azure.AI.TextAnalytics.TextAnalyticsResult" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ExtractiveSummarizeResult extends Azure.AI.TextAnalytics.TextAnalyticsResult" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.TextAnalytics.ExtractiveSummarizeResult" />
  <TypeSignature Language="VB.NET" Value="Public Class ExtractiveSummarizeResult&#xA;Inherits TextAnalyticsResult" />
  <TypeSignature Language="F#" Value="type ExtractiveSummarizeResult = class&#xA;    inherit TextAnalyticsResult" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
    <AssemblyVersion>5.3.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Azure.AI.TextAnalytics.TextAnalyticsResult</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            A representation of the result of performing extractive summarization on a given document.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="Sentences">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyCollection&lt;Azure.AI.TextAnalytics.ExtractiveSummarySentence&gt; Sentences { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyCollection`1&lt;valuetype Azure.AI.TextAnalytics.ExtractiveSummarySentence&gt; Sentences" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.ExtractiveSummarizeResult.Sentences" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Sentences As IReadOnlyCollection(Of ExtractiveSummarySentence)" />
      <MemberSignature Language="F#" Value="member this.Sentences : System.Collections.Generic.IReadOnlyCollection&lt;Azure.AI.TextAnalytics.ExtractiveSummarySentence&gt;" Usage="Azure.AI.TextAnalytics.ExtractiveSummarizeResult.Sentences" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IReadOnlyCollection&lt;Azure.AI.TextAnalytics.ExtractiveSummarySentence&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The collection of summary sentences extracted from the input document.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Warnings">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyCollection&lt;Azure.AI.TextAnalytics.TextAnalyticsWarning&gt; Warnings { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyCollection`1&lt;valuetype Azure.AI.TextAnalytics.TextAnalyticsWarning&gt; Warnings" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.ExtractiveSummarizeResult.Warnings" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Warnings As IReadOnlyCollection(Of TextAnalyticsWarning)" />
      <MemberSignature Language="F#" Value="member this.Warnings : System.Collections.Generic.IReadOnlyCollection&lt;Azure.AI.TextAnalytics.TextAnalyticsWarning&gt;" Usage="Azure.AI.TextAnalytics.ExtractiveSummarizeResult.Warnings" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IReadOnlyCollection&lt;Azure.AI.TextAnalytics.TextAnalyticsWarning&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The warnings that resulted from processing the document.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>