UnivariateChangePointDetectionOptions.xml

<Type Name="UnivariateChangePointDetectionOptions" FullName="Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions">
  <TypeSignature Language="C#" Value="public class UnivariateChangePointDetectionOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UnivariateChangePointDetectionOptions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class UnivariateChangePointDetectionOptions" />
  <TypeSignature Language="F#" Value="type UnivariateChangePointDetectionOptions = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary> Request of change point detection. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public UnivariateChangePointDetectionOptions (System.Collections.Generic.IEnumerable&lt;Azure.AI.AnomalyDetector.TimeSeriesPoint&gt; series, Azure.AI.AnomalyDetector.TimeGranularity granularity);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1&lt;class Azure.AI.AnomalyDetector.TimeSeriesPoint&gt; series, valuetype Azure.AI.AnomalyDetector.TimeGranularity granularity) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.#ctor(System.Collections.Generic.IEnumerable{Azure.AI.AnomalyDetector.TimeSeriesPoint},Azure.AI.AnomalyDetector.TimeGranularity)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (series As IEnumerable(Of TimeSeriesPoint), granularity As TimeGranularity)" />
      <MemberSignature Language="F#" Value="new Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions : seq&lt;Azure.AI.AnomalyDetector.TimeSeriesPoint&gt; * Azure.AI.AnomalyDetector.TimeGranularity -&gt; Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions" Usage="new Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions (series, granularity)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="series" Type="System.Collections.Generic.IEnumerable&lt;Azure.AI.AnomalyDetector.TimeSeriesPoint&gt;" />
        <Parameter Name="granularity" Type="Azure.AI.AnomalyDetector.TimeGranularity" />
      </Parameters>
      <Docs>
        <param name="series">
            Time series data points. Points should be sorted by time stamp in ascending
            order to match the change point detection result.
            </param>
        <param name="granularity"> Granularity is used to verify whether the input series is valid. </param>
        <summary> Initializes a new instance of UnivariateChangePointDetectionOptions. </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="series" /> is null. </exception>
      </Docs>
    </Member>
    <Member MemberName="CustomInterval">
      <MemberSignature Language="C#" Value="public int? CustomInterval { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; CustomInterval" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.CustomInterval" />
      <MemberSignature Language="VB.NET" Value="Public Property CustomInterval As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.CustomInterval : Nullable&lt;int&gt; with get, set" Usage="Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.CustomInterval" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            A custom interval is used to set a nonstandard time interval. For example, if the
            series is 5 minutes, the request can be set as {"granularity":"minutely",
            "customInterval":5}.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Granularity">
      <MemberSignature Language="C#" Value="public Azure.AI.AnomalyDetector.TimeGranularity Granularity { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.AnomalyDetector.TimeGranularity Granularity" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.Granularity" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Granularity As TimeGranularity" />
      <MemberSignature Language="F#" Value="member this.Granularity : Azure.AI.AnomalyDetector.TimeGranularity" Usage="Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.Granularity" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.AI.AnomalyDetector.TimeGranularity</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Granularity is used to verify whether the input series is valid. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Period">
      <MemberSignature Language="C#" Value="public int? Period { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; Period" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.Period" />
      <MemberSignature Language="VB.NET" Value="Public Property Period As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.Period : Nullable&lt;int&gt; with get, set" Usage="Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.Period" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Argument that indicates the periodic value of a time series. If the value is null or
            not present, the API will determine the period automatically.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Series">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Azure.AI.AnomalyDetector.TimeSeriesPoint&gt; Series { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Azure.AI.AnomalyDetector.TimeSeriesPoint&gt; Series" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.Series" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Series As IList(Of TimeSeriesPoint)" />
      <MemberSignature Language="F#" Value="member this.Series : System.Collections.Generic.IList&lt;Azure.AI.AnomalyDetector.TimeSeriesPoint&gt;" Usage="Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.Series" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Azure.AI.AnomalyDetector.TimeSeriesPoint&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Time series data points. Points should be sorted by time stamp in ascending
            order to match the change point detection result.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="StableTrendWindow">
      <MemberSignature Language="C#" Value="public int? StableTrendWindow { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; StableTrendWindow" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.StableTrendWindow" />
      <MemberSignature Language="VB.NET" Value="Public Property StableTrendWindow As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.StableTrendWindow : Nullable&lt;int&gt; with get, set" Usage="Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.StableTrendWindow" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Argument that indicates an advanced model parameter. A default stableTrendWindow value will
            be used in detection.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Threshold">
      <MemberSignature Language="C#" Value="public float? Threshold { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;float32&gt; Threshold" />
      <MemberSignature Language="DocId" Value="P:Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.Threshold" />
      <MemberSignature Language="VB.NET" Value="Public Property Threshold As Nullable(Of Single)" />
      <MemberSignature Language="F#" Value="member this.Threshold : Nullable&lt;single&gt; with get, set" Usage="Azure.AI.AnomalyDetector.UnivariateChangePointDetectionOptions.Threshold" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.AI.AnomalyDetector</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Single&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Argument that indicates an advanced model parameter between 0.0 and 1.0. The lower the
            value is, the larger the trend error is, which means less change point will
            be accepted.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>