MultiLabelClassifyAction.xml

<Type Name="MultiLabelClassifyAction" FullName="Azure.AI.TextAnalytics.MultiLabelClassifyAction">
  <TypeSignature Language="C#" Value="public class MultiLabelClassifyAction" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MultiLabelClassifyAction extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />
  <TypeSignature Language="VB.NET" Value="Public Class MultiLabelClassifyAction" />
  <TypeSignature Language="F#" Value="type MultiLabelClassifyAction = 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>
            Configurations that allow callers to specify details about how to execute
            a Multi Label Classification action on a set of documents. This corresponds
            to a Multi Classification task in the Language service.
            For example, the target project and deployment names are required
            for a successful custom classification action.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MultiLabelClassifyAction (string projectName, string deploymentName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string projectName, string deploymentName) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.MultiLabelClassifyAction.#ctor(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (projectName As String, deploymentName As String)" />
      <MemberSignature Language="F#" Value="new Azure.AI.TextAnalytics.MultiLabelClassifyAction : string * string -&gt; Azure.AI.TextAnalytics.MultiLabelClassifyAction" Usage="new Azure.AI.TextAnalytics.MultiLabelClassifyAction (projectName, deploymentName)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="projectName" Type="System.String" />
        <Parameter Name="deploymentName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="projectName">To be added.</param>
        <param name="deploymentName">To be added.</param>
        <summary>
            Initializes a new instance of the <see cref="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />
            class which allows callers to specify details about how to execute
            a Multi Label Classification action on a set of documents.
            Sets the <see cref="P:Azure.AI.TextAnalytics.MultiLabelClassifyAction.ProjectName" /> and <see cref="P:Azure.AI.TextAnalytics.MultiLabelClassifyAction.DeploymentName" /> properties.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ActionName">
      <MemberSignature Language="C#" Value="public string ActionName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ActionName" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.MultiLabelClassifyAction.ActionName" />
      <MemberSignature Language="VB.NET" Value="Public Property ActionName As String" />
      <MemberSignature Language="F#" Value="member this.ActionName : string with get, set" Usage="Azure.AI.TextAnalytics.MultiLabelClassifyAction.ActionName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a name for this action. If not provided, the service will generate one.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DeploymentName">
      <MemberSignature Language="C#" Value="public string DeploymentName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string DeploymentName" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.MultiLabelClassifyAction.DeploymentName" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeploymentName As String" />
      <MemberSignature Language="F#" Value="member this.DeploymentName : string" Usage="Azure.AI.TextAnalytics.MultiLabelClassifyAction.DeploymentName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the value of the property corresponding to the name of the target deployment.
            </summary>
        <value>To be added.</value>
        <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.MultiLabelClassifyAction.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.MultiLabelClassifyAction.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 'false'. This means, the Language service logs your input text for 48 hours,
            solely to allow for troubleshooting issues.
            Setting this property to true, 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>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ProjectName">
      <MemberSignature Language="C#" Value="public string ProjectName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ProjectName" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.TextAnalytics.MultiLabelClassifyAction.ProjectName" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ProjectName As String" />
      <MemberSignature Language="F#" Value="member this.ProjectName : string" Usage="Azure.AI.TextAnalytics.MultiLabelClassifyAction.ProjectName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.TextAnalytics</AssemblyName>
        <AssemblyVersion>5.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the value of the property corresponding to the name of the target project
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>