xml/Azure.AI.Vision.Face/LargeFaceListClient.xml

<Type Name="LargeFaceListClient" FullName="Azure.AI.Vision.Face.LargeFaceListClient"> <TypeSignature Language="C#" Value="public class LargeFaceListClient" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit LargeFaceListClient extends System.Object" /> <TypeSignature Language="DocId" Value="T:Azure.AI.Vision.Face.LargeFaceListClient" /> <TypeSignature Language="VB.NET" Value="Public Class LargeFaceListClient" /> <TypeSignature Language="F#" Value="type LargeFaceListClient = class" /> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces /> <Docs> <summary> The LargeFaceList sub-client. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected LargeFaceListClient ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.#ctor" /> <MemberSignature Language="VB.NET" Value="Protected Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary> Initializes a new instance of LargeFaceListClient for mocking. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public LargeFaceListClient (Uri endpoint, Azure.AzureKeyCredential credential, string largeFaceListId);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, string largeFaceListId) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.#ctor(System.Uri,Azure.AzureKeyCredential,System.String)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, largeFaceListId As String)" /> <MemberSignature Language="F#" Value="new Azure.AI.Vision.Face.LargeFaceListClient : Uri * Azure.AzureKeyCredential * string -> Azure.AI.Vision.Face.LargeFaceListClient" Usage="new Azure.AI.Vision.Face.LargeFaceListClient (endpoint, credential, largeFaceListId)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.AzureKeyCredential" /> <Parameter Name="largeFaceListId" Type="System.String" /> </Parameters> <Docs> <param name="endpoint"> Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). </param> <param name="largeFaceListId"> Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <summary> Initializes a new instance of FaceClient. </summary> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public LargeFaceListClient (Uri endpoint, Azure.Core.TokenCredential credential, string largeFaceListId);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, string largeFaceListId) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.#ctor(System.Uri,Azure.Core.TokenCredential,System.String)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, largeFaceListId As String)" /> <MemberSignature Language="F#" Value="new Azure.AI.Vision.Face.LargeFaceListClient : Uri * Azure.Core.TokenCredential * string -> Azure.AI.Vision.Face.LargeFaceListClient" Usage="new Azure.AI.Vision.Face.LargeFaceListClient (endpoint, credential, largeFaceListId)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> <Parameter Name="largeFaceListId" Type="System.String" /> </Parameters> <Docs> <param name="largeFaceListId">To be added.</param> <param name="endpoint"> <param name="largeFaceListId"> Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. </param> Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <summary> Initializes a new instance of FaceClient. </summary> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public LargeFaceListClient (Uri endpoint, Azure.AzureKeyCredential credential, string largeFaceListId, Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, string largeFaceListId, class Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.#ctor(System.Uri,Azure.AzureKeyCredential,System.String,Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, largeFaceListId As String, options As AzureAIVisionFaceClientOptions)" /> <MemberSignature Language="F#" Value="new Azure.AI.Vision.Face.LargeFaceListClient : Uri * Azure.AzureKeyCredential * string * Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions -> Azure.AI.Vision.Face.LargeFaceListClient" Usage="new Azure.AI.Vision.Face.LargeFaceListClient (endpoint, credential, largeFaceListId, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.AzureKeyCredential" /> <Parameter Name="largeFaceListId" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions" /> </Parameters> <Docs> <param name="endpoint"> Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). </param> <param name="largeFaceListId"> Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <param name="options"> The options for configuring the client. </param> <summary> Initializes a new instance of LargeFaceListClient. </summary> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public LargeFaceListClient (Uri endpoint, Azure.Core.TokenCredential credential, string largeFaceListId, Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, string largeFaceListId, class Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.#ctor(System.Uri,Azure.Core.TokenCredential,System.String,Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, largeFaceListId As String, options As AzureAIVisionFaceClientOptions)" /> <MemberSignature Language="F#" Value="new Azure.AI.Vision.Face.LargeFaceListClient : Uri * Azure.Core.TokenCredential * string * Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions -> Azure.AI.Vision.Face.LargeFaceListClient" Usage="new Azure.AI.Vision.Face.LargeFaceListClient (endpoint, credential, largeFaceListId, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> <Parameter Name="largeFaceListId" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.Vision.Face.AzureAIVisionFaceClientOptions" /> </Parameters> <Docs> <param name="endpoint"> Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). </param> <param name="largeFaceListId"> Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <param name="options"> The options for configuring the client. </param> <summary> Initializes a new instance of FaceClient. </summary> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception> </Docs> </Member> <Member MemberName="AddFace"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddFace (Azure.Core.RequestContent content, System.Collections.Generic.IEnumerable<int> targetFace = default, string detectionModel = default, string userData = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddFace(class Azure.Core.RequestContent content, class System.Collections.Generic.IEnumerable`1<int32> targetFace, string detectionModel, string userData, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.AddFace(Azure.Core.RequestContent,System.Collections.Generic.IEnumerable{System.Int32},System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddFace (content As RequestContent, Optional targetFace As IEnumerable(Of Integer) = Nothing, Optional detectionModel As String = Nothing, Optional userData As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddFace : Azure.Core.RequestContent * seq<int> * string * string * Azure.RequestContext -> Azure.Response
override this.AddFace : Azure.Core.RequestContent * seq<int> * string * string * Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.AddFace (content, targetFace, detectionModel, userData, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="targetFace" Type="System.Collections.Generic.IEnumerable<System.Int32>" /> <Parameter Name="detectionModel" Type="System.String" /> <Parameter Name="userData" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="targetFace"> A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. </param> <param name="detectionModel"> The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. Allowed values: "detection_01" | "detection_02" | "detection_03". </param> <param name="userData"> User-provided data attached to the face. The size limit is 1K. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add a face to a specified Large Face List, up to 1,000,000 faces. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.AddFace(System.BinaryData,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{Azure.AI.Vision.Face.FaceDetectionModel},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="AddFace"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Vision.Face.AddFaceResult> AddFace (BinaryData imageContent, System.Collections.Generic.IEnumerable<int> targetFace = default, Azure.AI.Vision.Face.FaceDetectionModel? detectionModel = default, string userData = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Vision.Face.AddFaceResult> AddFace(class System.BinaryData imageContent, class System.Collections.Generic.IEnumerable`1<int32> targetFace, valuetype System.Nullable`1<valuetype Azure.AI.Vision.Face.FaceDetectionModel> detectionModel, string userData, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.AddFace(System.BinaryData,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{Azure.AI.Vision.Face.FaceDetectionModel},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddFace (imageContent As BinaryData, Optional targetFace As IEnumerable(Of Integer) = Nothing, Optional detectionModel As Nullable(Of FaceDetectionModel) = Nothing, Optional userData As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AddFaceResult)" /> <MemberSignature Language="F#" Value="abstract member AddFace : BinaryData * seq<int> * Nullable<Azure.AI.Vision.Face.FaceDetectionModel> * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.AddFaceResult>
override this.AddFace : BinaryData * seq<int> * Nullable<Azure.AI.Vision.Face.FaceDetectionModel> * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.AddFaceResult>" Usage="largeFaceListClient.AddFace (imageContent, targetFace, detectionModel, userData, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.Vision.Face.AddFaceResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="imageContent" Type="System.BinaryData" /> <Parameter Name="targetFace" Type="System.Collections.Generic.IEnumerable<System.Int32>" /> <Parameter Name="detectionModel" Type="System.Nullable<Azure.AI.Vision.Face.FaceDetectionModel>" /> <Parameter Name="userData" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="imageContent"> The image to be analyzed. </param> <param name="targetFace"> A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. </param> <param name="detectionModel"> The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. </param> <param name="userData"> User-provided data attached to the face. The size limit is 1K. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add a face to a specified Large Face List, up to 1,000,000 faces. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/add-large-face-list-face for more details. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="imageContent" /> is null. </exception> </Docs> </Member> <Member MemberName="AddFace"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Vision.Face.AddFaceResult> AddFace (Uri uri, System.Collections.Generic.IEnumerable<int> targetFace = default, Azure.AI.Vision.Face.FaceDetectionModel? detectionModel = default, string userData = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Vision.Face.AddFaceResult> AddFace(class System.Uri uri, class System.Collections.Generic.IEnumerable`1<int32> targetFace, valuetype System.Nullable`1<valuetype Azure.AI.Vision.Face.FaceDetectionModel> detectionModel, string userData, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.AddFace(System.Uri,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{Azure.AI.Vision.Face.FaceDetectionModel},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddFace (uri As Uri, Optional targetFace As IEnumerable(Of Integer) = Nothing, Optional detectionModel As Nullable(Of FaceDetectionModel) = Nothing, Optional userData As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AddFaceResult)" /> <MemberSignature Language="F#" Value="abstract member AddFace : Uri * seq<int> * Nullable<Azure.AI.Vision.Face.FaceDetectionModel> * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.AddFaceResult>
override this.AddFace : Uri * seq<int> * Nullable<Azure.AI.Vision.Face.FaceDetectionModel> * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.AddFaceResult>" Usage="largeFaceListClient.AddFace (uri, targetFace, detectionModel, userData, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.Vision.Face.AddFaceResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="uri" Type="System.Uri" /> <Parameter Name="targetFace" Type="System.Collections.Generic.IEnumerable<System.Int32>" /> <Parameter Name="detectionModel" Type="System.Nullable<Azure.AI.Vision.Face.FaceDetectionModel>" /> <Parameter Name="userData" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="uri"> URL of input image. </param> <param name="targetFace"> A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. </param> <param name="detectionModel"> The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. </param> <param name="userData"> User-provided data attached to the face. The size limit is 1K. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add a face to a specified Large Face List, up to 1,000,000 faces. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/add-large-face-list-face-from-url for more details. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="uri" /> is null. </exception> </Docs> </Member> <Member MemberName="AddFaceAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddFaceAsync (Azure.Core.RequestContent content, System.Collections.Generic.IEnumerable<int> targetFace = default, string detectionModel = default, string userData = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddFaceAsync(class Azure.Core.RequestContent content, class System.Collections.Generic.IEnumerable`1<int32> targetFace, string detectionModel, string userData, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.AddFaceAsync(Azure.Core.RequestContent,System.Collections.Generic.IEnumerable{System.Int32},System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddFaceAsync (content As RequestContent, Optional targetFace As IEnumerable(Of Integer) = Nothing, Optional detectionModel As String = Nothing, Optional userData As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddFaceAsync : Azure.Core.RequestContent * seq<int> * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddFaceAsync : Azure.Core.RequestContent * seq<int> * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.AddFaceAsync (content, targetFace, detectionModel, userData, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="targetFace" Type="System.Collections.Generic.IEnumerable<System.Int32>" /> <Parameter Name="detectionModel" Type="System.String" /> <Parameter Name="userData" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="targetFace"> A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. </param> <param name="detectionModel"> The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. Allowed values: "detection_01" | "detection_02" | "detection_03". </param> <param name="userData"> User-provided data attached to the face. The size limit is 1K. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add a face to a specified Large Face List, up to 1,000,000 faces. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.AddFaceAsync(System.BinaryData,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{Azure.AI.Vision.Face.FaceDetectionModel},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="AddFaceAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.AddFaceResult>> AddFaceAsync (BinaryData imageContent, System.Collections.Generic.IEnumerable<int> targetFace = default, Azure.AI.Vision.Face.FaceDetectionModel? detectionModel = default, string userData = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.Vision.Face.AddFaceResult>> AddFaceAsync(class System.BinaryData imageContent, class System.Collections.Generic.IEnumerable`1<int32> targetFace, valuetype System.Nullable`1<valuetype Azure.AI.Vision.Face.FaceDetectionModel> detectionModel, string userData, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.AddFaceAsync(System.BinaryData,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{Azure.AI.Vision.Face.FaceDetectionModel},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddFaceAsync (imageContent As BinaryData, Optional targetFace As IEnumerable(Of Integer) = Nothing, Optional detectionModel As Nullable(Of FaceDetectionModel) = Nothing, Optional userData As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AddFaceResult))" /> <MemberSignature Language="F#" Value="abstract member AddFaceAsync : BinaryData * seq<int> * Nullable<Azure.AI.Vision.Face.FaceDetectionModel> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.AddFaceResult>>
override this.AddFaceAsync : BinaryData * seq<int> * Nullable<Azure.AI.Vision.Face.FaceDetectionModel> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.AddFaceResult>>" Usage="largeFaceListClient.AddFaceAsync (imageContent, targetFace, detectionModel, userData, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.AddFaceResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="imageContent" Type="System.BinaryData" /> <Parameter Name="targetFace" Type="System.Collections.Generic.IEnumerable<System.Int32>" /> <Parameter Name="detectionModel" Type="System.Nullable<Azure.AI.Vision.Face.FaceDetectionModel>" /> <Parameter Name="userData" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="imageContent"> The image to be analyzed. </param> <param name="targetFace"> A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. </param> <param name="detectionModel"> The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. </param> <param name="userData"> User-provided data attached to the face. The size limit is 1K. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add a face to a specified Large Face List, up to 1,000,000 faces. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/add-large-face-list-face for more details. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="imageContent" /> is null. </exception> </Docs> </Member> <Member MemberName="AddFaceAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.AddFaceResult>> AddFaceAsync (Uri uri, System.Collections.Generic.IEnumerable<int> targetFace = default, Azure.AI.Vision.Face.FaceDetectionModel? detectionModel = default, string userData = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.Vision.Face.AddFaceResult>> AddFaceAsync(class System.Uri uri, class System.Collections.Generic.IEnumerable`1<int32> targetFace, valuetype System.Nullable`1<valuetype Azure.AI.Vision.Face.FaceDetectionModel> detectionModel, string userData, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.AddFaceAsync(System.Uri,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{Azure.AI.Vision.Face.FaceDetectionModel},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddFaceAsync (uri As Uri, Optional targetFace As IEnumerable(Of Integer) = Nothing, Optional detectionModel As Nullable(Of FaceDetectionModel) = Nothing, Optional userData As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AddFaceResult))" /> <MemberSignature Language="F#" Value="abstract member AddFaceAsync : Uri * seq<int> * Nullable<Azure.AI.Vision.Face.FaceDetectionModel> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.AddFaceResult>>
override this.AddFaceAsync : Uri * seq<int> * Nullable<Azure.AI.Vision.Face.FaceDetectionModel> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.AddFaceResult>>" Usage="largeFaceListClient.AddFaceAsync (uri, targetFace, detectionModel, userData, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.AddFaceResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="uri" Type="System.Uri" /> <Parameter Name="targetFace" Type="System.Collections.Generic.IEnumerable<System.Int32>" /> <Parameter Name="detectionModel" Type="System.Nullable<Azure.AI.Vision.Face.FaceDetectionModel>" /> <Parameter Name="userData" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="uri"> URL of input image. </param> <param name="targetFace"> A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. </param> <param name="detectionModel"> The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. </param> <param name="userData"> User-provided data attached to the face. The size limit is 1K. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add a face to a specified Large Face List, up to 1,000,000 faces. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/add-large-face-list-face-from-url for more details. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="uri" /> is null. </exception> </Docs> </Member> <Member MemberName="Create"> <MemberSignature Language="C#" Value="public virtual Azure.Response Create (Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response Create(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.Create(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function Create (content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member Create : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.Create : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.Create (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.Create(System.String,System.String,System.Nullable{Azure.AI.Vision.Face.FaceRecognitionModel},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call Create. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); using RequestContent content = RequestContent.Create(new { name = "your_large_face_list_name", userData = "your_user_data", recognitionModel = "recognition_01", }); Response response = client.Create(content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="Create"> <MemberSignature Language="C#" Value="public virtual Azure.Response Create (string name, string userData = default, Azure.AI.Vision.Face.FaceRecognitionModel? recognitionModel = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response Create(string name, string userData, valuetype System.Nullable`1<valuetype Azure.AI.Vision.Face.FaceRecognitionModel> recognitionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.Create(System.String,System.String,System.Nullable{Azure.AI.Vision.Face.FaceRecognitionModel},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function Create (name As String, Optional userData As String = Nothing, Optional recognitionModel As Nullable(Of FaceRecognitionModel) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member Create : string * string * Nullable<Azure.AI.Vision.Face.FaceRecognitionModel> * System.Threading.CancellationToken -> Azure.Response
override this.Create : string * string * Nullable<Azure.AI.Vision.Face.FaceRecognitionModel> * System.Threading.CancellationToken -> Azure.Response" Usage="largeFaceListClient.Create (name, userData, recognitionModel, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="userData" Type="System.String" /> <Parameter Name="recognitionModel" Type="System.Nullable<Azure.AI.Vision.Face.FaceRecognitionModel>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> User defined name, maximum length is 128. </param> <param name="userData"> Optional user defined data. Length should not exceed 16K. </param> <param name="recognitionModel"> The 'recognitionModel' associated with this face list. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02, 'recognition_03', and 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/create-large-face-list for more details. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <example> This sample shows how to call Create. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = client.Create("your_large_face_list_name"); ]]></code></example> </Docs> </Member> <Member MemberName="CreateAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CreateAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> CreateAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.CreateAsync(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member CreateAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.CreateAsync (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.CreateAsync(System.String,System.String,System.Nullable{Azure.AI.Vision.Face.FaceRecognitionModel},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); using RequestContent content = RequestContent.Create(new { name = "your_large_face_list_name", userData = "your_user_data", recognitionModel = "recognition_01", }); Response response = await client.CreateAsync(content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="CreateAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CreateAsync (string name, string userData = default, Azure.AI.Vision.Face.FaceRecognitionModel? recognitionModel = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> CreateAsync(string name, string userData, valuetype System.Nullable`1<valuetype Azure.AI.Vision.Face.FaceRecognitionModel> recognitionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.CreateAsync(System.String,System.String,System.Nullable{Azure.AI.Vision.Face.FaceRecognitionModel},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateAsync (name As String, Optional userData As String = Nothing, Optional recognitionModel As Nullable(Of FaceRecognitionModel) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member CreateAsync : string * string * Nullable<Azure.AI.Vision.Face.FaceRecognitionModel> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateAsync : string * string * Nullable<Azure.AI.Vision.Face.FaceRecognitionModel> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.CreateAsync (name, userData, recognitionModel, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="userData" Type="System.String" /> <Parameter Name="recognitionModel" Type="System.Nullable<Azure.AI.Vision.Face.FaceRecognitionModel>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> User defined name, maximum length is 128. </param> <param name="userData"> Optional user defined data. Length should not exceed 16K. </param> <param name="recognitionModel"> The 'recognitionModel' associated with this face list. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02, 'recognition_03', and 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/create-large-face-list for more details. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <example> This sample shows how to call CreateAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = await client.CreateAsync("your_large_face_list_name"); ]]></code></example> </Docs> </Member> <Member MemberName="Delete"> <MemberSignature Language="C#" Value="public virtual Azure.Response Delete (Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response Delete(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.Delete(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function Delete (Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member Delete : Azure.RequestContext -> Azure.Response
override this.Delete : Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.Delete context" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call Delete. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = client.Delete(); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteAsync (Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteAsync(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.DeleteAsync(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteAsync (Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member DeleteAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.DeleteAsync context" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = await client.DeleteAsync(); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteFace"> <MemberSignature Language="C#" Value="public virtual Azure.Response DeleteFace (Guid persistedFaceId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DeleteFace(valuetype System.Guid persistedFaceId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.DeleteFace(System.Guid,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteFace (persistedFaceId As Guid, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member DeleteFace : Guid * Azure.RequestContext -> Azure.Response
override this.DeleteFace : Guid * Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.DeleteFace (persistedFaceId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="persistedFaceId" Type="System.Guid" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="persistedFaceId"> Face ID of the face. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/delete-large-face-list-face for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteFace. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = client.DeleteFace(Guid.Parse("43897a75-8d6f-42cf-885e-74832febb055")); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteFaceAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteFaceAsync (Guid persistedFaceId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteFaceAsync(valuetype System.Guid persistedFaceId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.DeleteFaceAsync(System.Guid,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteFaceAsync (persistedFaceId As Guid, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member DeleteFaceAsync : Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteFaceAsync : Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.DeleteFaceAsync (persistedFaceId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="persistedFaceId" Type="System.Guid" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="persistedFaceId"> Face ID of the face. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/delete-large-face-list-face for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteFaceAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = await client.DeleteFaceAsync(Guid.Parse("43897a75-8d6f-42cf-885e-74832febb055")); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="GetFace"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetFace (Guid persistedFaceId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetFace(valuetype System.Guid persistedFaceId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFace(System.Guid,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetFace (persistedFaceId As Guid, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetFace : Guid * Azure.RequestContext -> Azure.Response
override this.GetFace : Guid * Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.GetFace (persistedFaceId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="persistedFaceId" Type="System.Guid" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="persistedFaceId"> Face ID of the face. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-face for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFace(System.Guid,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetFace and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = client.GetFace(Guid.Parse("43897a75-8d6f-42cf-885e-74832febb055"), null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("persistedFaceId").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetFace"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Vision.Face.LargeFaceListFace> GetFace (Guid persistedFaceId, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Vision.Face.LargeFaceListFace> GetFace(valuetype System.Guid persistedFaceId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFace(System.Guid,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetFace (persistedFaceId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Response(Of LargeFaceListFace)" /> <MemberSignature Language="F#" Value="abstract member GetFace : Guid * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.LargeFaceListFace>
override this.GetFace : Guid * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.LargeFaceListFace>" Usage="largeFaceListClient.GetFace (persistedFaceId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.Vision.Face.LargeFaceListFace></ReturnType> </ReturnValue> <Parameters> <Parameter Name="persistedFaceId" Type="System.Guid" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="persistedFaceId"> Face ID of the face. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-face for more details. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetFace. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response<LargeFaceListFace> response = client.GetFace(Guid.Parse("43897a75-8d6f-42cf-885e-74832febb055")); ]]></code></example> </Docs> </Member> <Member MemberName="GetFaceAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetFaceAsync (Guid persistedFaceId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetFaceAsync(valuetype System.Guid persistedFaceId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFaceAsync(System.Guid,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetFaceAsync (persistedFaceId As Guid, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetFaceAsync : Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetFaceAsync : Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.GetFaceAsync (persistedFaceId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="persistedFaceId" Type="System.Guid" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="persistedFaceId"> Face ID of the face. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-face for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFaceAsync(System.Guid,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetFaceAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = await client.GetFaceAsync(Guid.Parse("43897a75-8d6f-42cf-885e-74832febb055"), null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("persistedFaceId").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetFaceAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargeFaceListFace>> GetFaceAsync (Guid persistedFaceId, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.Vision.Face.LargeFaceListFace>> GetFaceAsync(valuetype System.Guid persistedFaceId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFaceAsync(System.Guid,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetFaceAsync (persistedFaceId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of LargeFaceListFace))" /> <MemberSignature Language="F#" Value="abstract member GetFaceAsync : Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargeFaceListFace>>
override this.GetFaceAsync : Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargeFaceListFace>>" Usage="largeFaceListClient.GetFaceAsync (persistedFaceId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargeFaceListFace>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="persistedFaceId" Type="System.Guid" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="persistedFaceId"> Face ID of the face. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-face for more details. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetFaceAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response<LargeFaceListFace> response = await client.GetFaceAsync(Guid.Parse("43897a75-8d6f-42cf-885e-74832febb055")); ]]></code></example> </Docs> </Member> <Member MemberName="GetFaces"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetFaces (string start, int? top, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetFaces(string start, valuetype System.Nullable`1<int32> top, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFaces(System.String,System.Nullable{System.Int32},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetFaces (start As String, top As Nullable(Of Integer), context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetFaces : string * Nullable<int> * Azure.RequestContext -> Azure.Response
override this.GetFaces : string * Nullable<int> * Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.GetFaces (start, top, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.String" /> <Parameter Name="top" Type="System.Nullable<System.Int32>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="start"> List resources greater than the "start". It contains no more than 64 characters. Default is empty. </param> <param name="top"> The number of items to list, ranging in [1, 1000]. Default is 1000. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] List faces' persistedFaceId and userData in a specified Large Face List. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFaces(System.String,System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetFaces and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = client.GetFaces("00000000-0000-0000-0000-000000000000", 20, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result[0].GetProperty("persistedFaceId").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetFaces"> <MemberSignature Language="C#" Value="public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>> GetFaces (string start = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.Vision.Face.LargeFaceListFace>> GetFaces(string start, valuetype System.Nullable`1<int32> top, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFaces(System.String,System.Nullable{System.Int32},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetFaces (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of LargeFaceListFace))" /> <MemberSignature Language="F#" Value="abstract member GetFaces : string * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>>
override this.GetFaces : string * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>>" Usage="largeFaceListClient.GetFaces (start, top, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.String" /> <Parameter Name="top" Type="System.Nullable<System.Int32>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="start"> List resources greater than the "start". It contains no more than 64 characters. Default is empty. </param> <param name="top"> The number of items to list, ranging in [1, 1000]. Default is 1000. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> List faces' persistedFaceId and userData in a specified Large Face List. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-faces for more details. </remarks> <example> This sample shows how to call GetFaces. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response<IReadOnlyList<LargeFaceListFace>> response = client.GetFaces(); ]]></code></example> </Docs> </Member> <Member MemberName="GetFacesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetFacesAsync (string start, int? top, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetFacesAsync(string start, valuetype System.Nullable`1<int32> top, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFacesAsync(System.String,System.Nullable{System.Int32},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetFacesAsync (start As String, top As Nullable(Of Integer), context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetFacesAsync : string * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetFacesAsync : string * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.GetFacesAsync (start, top, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.String" /> <Parameter Name="top" Type="System.Nullable<System.Int32>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="start"> List resources greater than the "start". It contains no more than 64 characters. Default is empty. </param> <param name="top"> The number of items to list, ranging in [1, 1000]. Default is 1000. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] List faces' persistedFaceId and userData in a specified Large Face List. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFacesAsync(System.String,System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetFacesAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = await client.GetFacesAsync("00000000-0000-0000-0000-000000000000", 20, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result[0].GetProperty("persistedFaceId").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetFacesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>>> GetFacesAsync (string start = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.Vision.Face.LargeFaceListFace>>> GetFacesAsync(string start, valuetype System.Nullable`1<int32> top, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetFacesAsync(System.String,System.Nullable{System.Int32},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetFacesAsync (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IReadOnlyList(Of LargeFaceListFace)))" /> <MemberSignature Language="F#" Value="abstract member GetFacesAsync : string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>>>
override this.GetFacesAsync : string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>>>" Usage="largeFaceListClient.GetFacesAsync (start, top, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.String" /> <Parameter Name="top" Type="System.Nullable<System.Int32>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="start"> List resources greater than the "start". It contains no more than 64 characters. Default is empty. </param> <param name="top"> The number of items to list, ranging in [1, 1000]. Default is 1000. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> List faces' persistedFaceId and userData in a specified Large Face List. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-faces for more details. </remarks> <example> This sample shows how to call GetFacesAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response<IReadOnlyList<LargeFaceListFace>> response = await client.GetFacesAsync(); ]]></code></example> </Docs> </Member> <Member MemberName="GetLargeFaceList"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetLargeFaceList (bool? returnRecognitionModel, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetLargeFaceList(valuetype System.Nullable`1<bool> returnRecognitionModel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceList(System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLargeFaceList (returnRecognitionModel As Nullable(Of Boolean), context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetLargeFaceList : Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.GetLargeFaceList : Nullable<bool> * Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.GetLargeFaceList (returnRecognitionModel, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="returnRecognitionModel"> Return 'recognitionModel' or not. The default value is false. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceList(System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetLargeFaceList and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = client.GetLargeFaceList(true, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("name").ToString()); Console.WriteLine(result.GetProperty("largeFaceListId").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetLargeFaceList"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Vision.Face.LargeFaceList> GetLargeFaceList (bool? returnRecognitionModel = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Vision.Face.LargeFaceList> GetLargeFaceList(valuetype System.Nullable`1<bool> returnRecognitionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceList(System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLargeFaceList (Optional returnRecognitionModel As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of LargeFaceList)" /> <MemberSignature Language="F#" Value="abstract member GetLargeFaceList : Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.LargeFaceList>
override this.GetLargeFaceList : Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.LargeFaceList>" Usage="largeFaceListClient.GetLargeFaceList (returnRecognitionModel, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.Vision.Face.LargeFaceList></ReturnType> </ReturnValue> <Parameters> <Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="returnRecognitionModel"> Return 'recognitionModel' or not. The default value is false. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list for more details. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetLargeFaceList. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response<LargeFaceList> response = client.GetLargeFaceList(); ]]></code></example> </Docs> </Member> <Member MemberName="GetLargeFaceListAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetLargeFaceListAsync (bool? returnRecognitionModel, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetLargeFaceListAsync(valuetype System.Nullable`1<bool> returnRecognitionModel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceListAsync(System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLargeFaceListAsync (returnRecognitionModel As Nullable(Of Boolean), context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetLargeFaceListAsync : Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetLargeFaceListAsync : Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.GetLargeFaceListAsync (returnRecognitionModel, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="returnRecognitionModel"> Return 'recognitionModel' or not. The default value is false. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceListAsync(System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetLargeFaceListAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = await client.GetLargeFaceListAsync(true, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("name").ToString()); Console.WriteLine(result.GetProperty("largeFaceListId").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetLargeFaceListAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargeFaceList>> GetLargeFaceListAsync (bool? returnRecognitionModel = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.Vision.Face.LargeFaceList>> GetLargeFaceListAsync(valuetype System.Nullable`1<bool> returnRecognitionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceListAsync(System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLargeFaceListAsync (Optional returnRecognitionModel As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of LargeFaceList))" /> <MemberSignature Language="F#" Value="abstract member GetLargeFaceListAsync : Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargeFaceList>>
override this.GetLargeFaceListAsync : Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargeFaceList>>" Usage="largeFaceListClient.GetLargeFaceListAsync (returnRecognitionModel, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargeFaceList>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="returnRecognitionModel"> Return 'recognitionModel' or not. The default value is false. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list for more details. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetLargeFaceListAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response<LargeFaceList> response = await client.GetLargeFaceListAsync(); ]]></code></example> </Docs> </Member> <Member MemberName="GetLargeFaceLists"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetLargeFaceLists (string start, int? top, bool? returnRecognitionModel, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetLargeFaceLists(string start, valuetype System.Nullable`1<int32> top, valuetype System.Nullable`1<bool> returnRecognitionModel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceLists(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLargeFaceLists (start As String, top As Nullable(Of Integer), returnRecognitionModel As Nullable(Of Boolean), context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetLargeFaceLists : string * Nullable<int> * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.GetLargeFaceLists : string * Nullable<int> * Nullable<bool> * Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.GetLargeFaceLists (start, top, returnRecognitionModel, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.String" /> <Parameter Name="top" Type="System.Nullable<System.Int32>" /> <Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="start"> List resources greater than the "start". It contains no more than 64 characters. Default is empty. </param> <param name="top"> The number of items to list, ranging in [1, 1000]. Default is 1000. </param> <param name="returnRecognitionModel"> Return 'recognitionModel' or not. The default value is false. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceLists(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetLargeFaceLists and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient(null); Response response = client.GetLargeFaceLists("my_list_id", 20, true, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result[0].GetProperty("name").ToString()); Console.WriteLine(result[0].GetProperty("largeFaceListId").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetLargeFaceLists"> <MemberSignature Language="C#" Value="public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>> GetLargeFaceLists (string start = default, int? top = default, bool? returnRecognitionModel = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.Vision.Face.LargeFaceList>> GetLargeFaceLists(string start, valuetype System.Nullable`1<int32> top, valuetype System.Nullable`1<bool> returnRecognitionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceLists(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLargeFaceLists (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional returnRecognitionModel As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of LargeFaceList))" /> <MemberSignature Language="F#" Value="abstract member GetLargeFaceLists : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>
override this.GetLargeFaceLists : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>" Usage="largeFaceListClient.GetLargeFaceLists (start, top, returnRecognitionModel, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.String" /> <Parameter Name="top" Type="System.Nullable<System.Int32>" /> <Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="start"> List resources greater than the "start". It contains no more than 64 characters. Default is empty. </param> <param name="top"> The number of items to list, ranging in [1, 1000]. Default is 1000. </param> <param name="returnRecognitionModel"> Return 'recognitionModel' or not. The default value is false. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-lists for more details. </remarks> <example> This sample shows how to call GetLargeFaceLists. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient(null); Response<IReadOnlyList<LargeFaceList>> response = client.GetLargeFaceLists(); ]]></code></example> </Docs> </Member> <Member MemberName="GetLargeFaceListsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetLargeFaceListsAsync (string start, int? top, bool? returnRecognitionModel, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetLargeFaceListsAsync(string start, valuetype System.Nullable`1<int32> top, valuetype System.Nullable`1<bool> returnRecognitionModel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceListsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLargeFaceListsAsync (start As String, top As Nullable(Of Integer), returnRecognitionModel As Nullable(Of Boolean), context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetLargeFaceListsAsync : string * Nullable<int> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetLargeFaceListsAsync : string * Nullable<int> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.GetLargeFaceListsAsync (start, top, returnRecognitionModel, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.String" /> <Parameter Name="top" Type="System.Nullable<System.Int32>" /> <Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="start"> List resources greater than the "start". It contains no more than 64 characters. Default is empty. </param> <param name="top"> The number of items to list, ranging in [1, 1000]. Default is 1000. </param> <param name="returnRecognitionModel"> Return 'recognitionModel' or not. The default value is false. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceListsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetLargeFaceListsAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient(null); Response response = await client.GetLargeFaceListsAsync("my_list_id", 20, true, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result[0].GetProperty("name").ToString()); Console.WriteLine(result[0].GetProperty("largeFaceListId").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetLargeFaceListsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>> GetLargeFaceListsAsync (string start = default, int? top = default, bool? returnRecognitionModel = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.Vision.Face.LargeFaceList>>> GetLargeFaceListsAsync(string start, valuetype System.Nullable`1<int32> top, valuetype System.Nullable`1<bool> returnRecognitionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetLargeFaceListsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLargeFaceListsAsync (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional returnRecognitionModel As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IReadOnlyList(Of LargeFaceList)))" /> <MemberSignature Language="F#" Value="abstract member GetLargeFaceListsAsync : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>>
override this.GetLargeFaceListsAsync : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>>" Usage="largeFaceListClient.GetLargeFaceListsAsync (start, top, returnRecognitionModel, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.String" /> <Parameter Name="top" Type="System.Nullable<System.Int32>" /> <Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="start"> List resources greater than the "start". It contains no more than 64 characters. Default is empty. </param> <param name="top"> The number of items to list, ranging in [1, 1000]. Default is 1000. </param> <param name="returnRecognitionModel"> Return 'recognitionModel' or not. The default value is false. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel. </summary> <returns>To be added.</returns> <remarks> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-lists for more details. </remarks> <example> This sample shows how to call GetLargeFaceListsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient(null); Response<IReadOnlyList<LargeFaceList>> response = await client.GetLargeFaceListsAsync(); ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingStatus"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetTrainingStatus (Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetTrainingStatus(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetTrainingStatus(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingStatus (context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetTrainingStatus : Azure.RequestContext -> Azure.Response
override this.GetTrainingStatus : Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.GetTrainingStatus context" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-training-status for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetTrainingStatus(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainingStatus and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = client.GetTrainingStatus(null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastActionDateTime").ToString()); Console.WriteLine(result.GetProperty("lastSuccessfulTrainingDateTime").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingStatus"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult> GetTrainingStatus (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Vision.Face.FaceTrainingResult> GetTrainingStatus(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetTrainingStatus(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingStatus (Optional cancellationToken As CancellationToken = Nothing) As Response(Of FaceTrainingResult)" /> <MemberSignature Language="F#" Value="abstract member GetTrainingStatus : System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult>
override this.GetTrainingStatus : System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult>" Usage="largeFaceListClient.GetTrainingStatus cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-training-status for more details. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetTrainingStatus. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response<FaceTrainingResult> response = client.GetTrainingStatus(); ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingStatusAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetTrainingStatusAsync (Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetTrainingStatusAsync(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetTrainingStatusAsync(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingStatusAsync (context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetTrainingStatusAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetTrainingStatusAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.GetTrainingStatusAsync context" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-training-status for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.Vision.Face.LargeFaceListClient.GetTrainingStatusAsync(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainingStatusAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response response = await client.GetTrainingStatusAsync(null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastActionDateTime").ToString()); Console.WriteLine(result.GetProperty("lastSuccessfulTrainingDateTime").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingStatusAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult>> GetTrainingStatusAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.Vision.Face.FaceTrainingResult>> GetTrainingStatusAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.GetTrainingStatusAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingStatusAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of FaceTrainingResult))" /> <MemberSignature Language="F#" Value="abstract member GetTrainingStatusAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult>>
override this.GetTrainingStatusAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult>>" Usage="largeFaceListClient.GetTrainingStatusAsync cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-list-training-status for more details. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetTrainingStatusAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Response<FaceTrainingResult> response = await client.GetTrainingStatusAsync(); ]]></code></example> </Docs> </Member> <Member MemberName="Pipeline"> <MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" /> <MemberSignature Language="DocId" Value="P:Azure.AI.Vision.Face.LargeFaceListClient.Pipeline" /> <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" /> <MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.AI.Vision.Face.LargeFaceListClient.Pipeline" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType> </ReturnValue> <Docs> <summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Train"> <MemberSignature Language="C#" Value="public virtual Azure.Operation Train (Azure.WaitUntil waitUntil, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation Train(valuetype Azure.WaitUntil waitUntil, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.Train(Azure.WaitUntil,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function Train (waitUntil As WaitUntil, Optional context As RequestContext = Nothing) As Operation" /> <MemberSignature Language="F#" Value="abstract member Train : Azure.WaitUntil * Azure.RequestContext -> Azure.Operation
override this.Train : Azure.WaitUntil * Azure.RequestContext -> Azure.Operation" Usage="largeFaceListClient.Train (waitUntil, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Operation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Submit a Large Face List training task. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call Train. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Operation operation = client.Train(WaitUntil.Completed); ]]></code></example> </Docs> </Member> <Member MemberName="TrainAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation> TrainAsync (Azure.WaitUntil waitUntil, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation> TrainAsync(valuetype Azure.WaitUntil waitUntil, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.TrainAsync(Azure.WaitUntil,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function TrainAsync (waitUntil As WaitUntil, Optional context As RequestContext = Nothing) As Task(Of Operation)" /> <MemberSignature Language="F#" Value="abstract member TrainAsync : Azure.WaitUntil * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.TrainAsync : Azure.WaitUntil * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>" Usage="largeFaceListClient.TrainAsync (waitUntil, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Operation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Submit a Large Face List training task. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call TrainAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); Operation operation = await client.TrainAsync(WaitUntil.Completed); ]]></code></example> </Docs> </Member> <Member MemberName="Update"> <MemberSignature Language="C#" Value="public virtual Azure.Response Update (Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response Update(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.Update(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function Update (content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member Update : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.Update : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.Update (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/update-large-face-list for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call Update. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); using RequestContent content = RequestContent.Create(new { name = "your_large_face_list_name", userData = "your_user_data", }); Response response = client.Update(content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> UpdateAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> UpdateAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.UpdateAsync(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member UpdateAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.UpdateAsync (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/update-large-face-list for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); using RequestContent content = RequestContent.Create(new { name = "your_large_face_list_name", userData = "your_user_data", }); Response response = await client.UpdateAsync(content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateFace"> <MemberSignature Language="C#" Value="public virtual Azure.Response UpdateFace (Guid persistedFaceId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response UpdateFace(valuetype System.Guid persistedFaceId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.UpdateFace(System.Guid,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateFace (persistedFaceId As Guid, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member UpdateFace : Guid * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.UpdateFace : Guid * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="largeFaceListClient.UpdateFace (persistedFaceId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="persistedFaceId" Type="System.Guid" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="persistedFaceId"> Face ID of the face. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/update-large-face-list-face for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateFace. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); using RequestContent content = RequestContent.Create(new { userData = "your_user_data", }); Response response = client.UpdateFace(Guid.Parse("43897a75-8d6f-42cf-885e-74832febb055"), content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateFaceAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> UpdateFaceAsync (Guid persistedFaceId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> UpdateFaceAsync(valuetype System.Guid persistedFaceId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Vision.Face.LargeFaceListClient.UpdateFaceAsync(System.Guid,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateFaceAsync (persistedFaceId As Guid, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member UpdateFaceAsync : Guid * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateFaceAsync : Guid * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="largeFaceListClient.UpdateFaceAsync (persistedFaceId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Vision.Face</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="persistedFaceId" Type="System.Guid" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="persistedFaceId"> Face ID of the face. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/update-large-face-list-face for more details. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateFaceAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id"); using RequestContent content = RequestContent.Create(new { userData = "your_user_data", }); Response response = await client.UpdateFaceAsync(Guid.Parse("43897a75-8d6f-42cf-885e-74832febb055"), content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> </Members> </Type>

xml/Azure.AI.Vision.Face/LargeFaceListClient.xml (1,798 lines of code) (raw):