RecognizeCustomEntitiesOptions.xml

<Type Name="RecognizeCustomEntitiesOptions" FullName="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions">
  <TypeSignature Language="C#" Value="public class RecognizeCustomEntitiesOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RecognizeCustomEntitiesOptions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class RecognizeCustomEntitiesOptions" />
  <TypeSignature Language="F#" Value="type RecognizeCustomEntitiesOptions = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
    <AssemblyVersion>5.2.0.0</AssemblyVersion>
    <AssemblyVersion>5.3.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Options that allow callers to specify details about how the operation
            is run and what information is returned from it by the service.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RecognizeCustomEntitiesOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Initializes a new instance of the <see cref="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" />
            class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DisableServiceLogs">
      <MemberSignature Language="C#" Value="public bool? DisableServiceLogs { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; DisableServiceLogs" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions.DisableServiceLogs" />
      <MemberSignature Language="VB.NET" Value="Public Property DisableServiceLogs As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.DisableServiceLogs : Nullable&lt;bool&gt; with get, set" Usage="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions.DisableServiceLogs" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The default value of this property is <c>false</c>.
            This means that the Language service logs your input text for 48 hours solely to allow for troubleshooting issues.
            Setting this property to <c>true</c> disables input logging and may limit our ability to investigate issues that occur.
            <para>
            Please see Cognitive Services Compliance and Privacy notes at <see href="https://aka.ms/cs-compliance" /> for additional details,
            and Microsoft Responsible AI principles at <see href="https://www.microsoft.com/ai/responsible-ai" />.
            </para></summary>
        <value>To be added.</value>
        <remarks>
            This property only applies for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and up.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="DisplayName">
      <MemberSignature Language="C#" Value="public string DisplayName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string DisplayName" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions.DisplayName" />
      <MemberSignature Language="VB.NET" Value="Public Property DisplayName As String" />
      <MemberSignature Language="F#" Value="member this.DisplayName : string with get, set" Usage="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions.DisplayName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Optional display name for the operation.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IncludeStatistics">
      <MemberSignature Language="C#" Value="public bool? IncludeStatistics { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; IncludeStatistics" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions.IncludeStatistics" />
      <MemberSignature Language="VB.NET" Value="Public Property IncludeStatistics As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.IncludeStatistics : Nullable&lt;bool&gt; with get, set" Usage="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions.IncludeStatistics" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a value that, if set to true, indicates that the service
            should return document and document batch statistics with the results
            of the operation.
            Returns data for batch document methods only.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>