xml/Azure.AI.DocumentIntelligence/DocumentIntelligenceAdministrationClient.xml (4,107 lines of code) (raw):
<Type Name="DocumentIntelligenceAdministrationClient" FullName="Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient">
<TypeSignature Language="C#" Value="public class DocumentIntelligenceAdministrationClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DocumentIntelligenceAdministrationClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient" />
<TypeSignature Language="VB.NET" Value="Public Class DocumentIntelligenceAdministrationClient" />
<TypeSignature Language="F#" Value="type DocumentIntelligenceAdministrationClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The DocumentIntelligenceAdministration service client. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DocumentIntelligenceAdministrationClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of DocumentIntelligenceAdministrationClient for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentIntelligenceAdministrationClient (Uri endpoint, Azure.AzureKeyCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.#ctor(System.Uri,Azure.AzureKeyCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential)" />
<MemberSignature Language="F#" Value="new Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient : Uri * Azure.AzureKeyCredential -> Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient" Usage="new Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
</Parameters>
<Docs>
<param name="endpoint"> The Document Intelligence service endpoint. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of DocumentIntelligenceAdministrationClient. </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 DocumentIntelligenceAdministrationClient (Uri endpoint, Azure.Core.TokenCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.#ctor(System.Uri,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient : Uri * Azure.Core.TokenCredential -> Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient" Usage="new Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="endpoint"> The Document Intelligence service endpoint. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of DocumentIntelligenceAdministrationClient. </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 DocumentIntelligenceAdministrationClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, class Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, options As DocumentIntelligenceClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient : Uri * Azure.AzureKeyCredential * Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions -> Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient" Usage="new Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> The Document Intelligence service endpoint. </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 DocumentIntelligenceAdministrationClient. </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 DocumentIntelligenceAdministrationClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As DocumentIntelligenceClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient : Uri * Azure.Core.TokenCredential * Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions -> Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient" Usage="new Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.DocumentIntelligenceClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> The Document Intelligence service endpoint. </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 DocumentIntelligenceAdministrationClient. </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="AuthorizeClassifierCopy">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization> AuthorizeClassifierCopy (Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent authorizeCopyRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization> AuthorizeClassifierCopy(class Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent authorizeCopyRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeClassifierCopy(Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeClassifierCopy (authorizeCopyRequest As AuthorizeClassifierCopyContent, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ClassifierCopyAuthorization)" />
<MemberSignature Language="F#" Value="abstract member AuthorizeClassifierCopy : Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>
override this.AuthorizeClassifierCopy : Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>" Usage="documentIntelligenceAdministrationClient.AuthorizeClassifierCopy (authorizeCopyRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authorizeCopyRequest" Type="Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="authorizeCopyRequest"> Authorize copy request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Generates authorization to copy a document classifier to this location with
specified classifierId and optional description.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="authorizeCopyRequest" /> is null. </exception>
<example>
This sample shows how to call AuthorizeClassifierCopy.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeClassifierCopyContent authorizeCopyRequest = new AuthorizeClassifierCopyContent("<classifierId>");
Response<ClassifierCopyAuthorization> response = client.AuthorizeClassifierCopy(authorizeCopyRequest);
]]></code>
This sample shows how to call AuthorizeClassifierCopy with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeClassifierCopyContent authorizeCopyRequest = new AuthorizeClassifierCopyContent("<classifierId>")
{
Description = "<description>",
Tags =
{
["key"] = "<tags>"
},
};
Response<ClassifierCopyAuthorization> response = client.AuthorizeClassifierCopy(authorizeCopyRequest);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeClassifierCopy">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization> AuthorizeClassifierCopy (Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization> AuthorizeClassifierCopy(class Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeClassifierCopy(Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeClassifierCopy (options As AuthorizeClassifierCopyOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ClassifierCopyAuthorization)" />
<MemberSignature Language="F#" Value="abstract member AuthorizeClassifierCopy : Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>
override this.AuthorizeClassifierCopy : Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>" Usage="documentIntelligenceAdministrationClient.AuthorizeClassifierCopy (options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="options"> Authorize copy request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Generates authorization to copy a document classifier to this location with
specified classifierId and optional description.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call AuthorizeClassifierCopy.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeClassifierCopyOptions authorizeCopyRequest = new AuthorizeClassifierCopyOptions("targetClassifier")
{
Description = "Target classifier description",
};
Response<ClassifierCopyAuthorization> response = client.AuthorizeClassifierCopy(authorizeCopyRequest);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeClassifierCopy">
<MemberSignature Language="C#" Value="public virtual Azure.Response AuthorizeClassifierCopy (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AuthorizeClassifierCopy(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeClassifierCopy(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeClassifierCopy (content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member AuthorizeClassifierCopy : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AuthorizeClassifierCopy : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="documentIntelligenceAdministrationClient.AuthorizeClassifierCopy (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</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] Generates authorization to copy a document classifier to this location with
specified classifierId and optional description.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeClassifierCopy(Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions,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 AuthorizeClassifierCopy and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
classifierId = "targetClassifier",
description = "Target classifier description",
});
Response response = client.AuthorizeClassifierCopy(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("targetResourceId").ToString());
Console.WriteLine(result.GetProperty("targetResourceRegion").ToString());
Console.WriteLine(result.GetProperty("targetClassifierId").ToString());
Console.WriteLine(result.GetProperty("targetClassifierLocation").ToString());
Console.WriteLine(result.GetProperty("accessToken").ToString());
Console.WriteLine(result.GetProperty("expirationDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeClassifierCopyAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>> AuthorizeClassifierCopyAsync (Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent authorizeCopyRequest, 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.DocumentIntelligence.ClassifierCopyAuthorization>> AuthorizeClassifierCopyAsync(class Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent authorizeCopyRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeClassifierCopyAsync(Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeClassifierCopyAsync (authorizeCopyRequest As AuthorizeClassifierCopyContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ClassifierCopyAuthorization))" />
<MemberSignature Language="F#" Value="abstract member AuthorizeClassifierCopyAsync : Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>>
override this.AuthorizeClassifierCopyAsync : Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>>" Usage="documentIntelligenceAdministrationClient.AuthorizeClassifierCopyAsync (authorizeCopyRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authorizeCopyRequest" Type="Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyContent" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="authorizeCopyRequest"> Authorize copy request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Generates authorization to copy a document classifier to this location with
specified classifierId and optional description.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="authorizeCopyRequest" /> is null. </exception>
<example>
This sample shows how to call AuthorizeClassifierCopyAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeClassifierCopyContent authorizeCopyRequest = new AuthorizeClassifierCopyContent("<classifierId>");
Response<ClassifierCopyAuthorization> response = await client.AuthorizeClassifierCopyAsync(authorizeCopyRequest);
]]></code>
This sample shows how to call AuthorizeClassifierCopyAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeClassifierCopyContent authorizeCopyRequest = new AuthorizeClassifierCopyContent("<classifierId>")
{
Description = "<description>",
Tags =
{
["key"] = "<tags>"
},
};
Response<ClassifierCopyAuthorization> response = await client.AuthorizeClassifierCopyAsync(authorizeCopyRequest);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeClassifierCopyAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>> AuthorizeClassifierCopyAsync (Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions options, 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.DocumentIntelligence.ClassifierCopyAuthorization>> AuthorizeClassifierCopyAsync(class Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeClassifierCopyAsync(Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeClassifierCopyAsync (options As AuthorizeClassifierCopyOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ClassifierCopyAuthorization))" />
<MemberSignature Language="F#" Value="abstract member AuthorizeClassifierCopyAsync : Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>>
override this.AuthorizeClassifierCopyAsync : Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>>" Usage="documentIntelligenceAdministrationClient.AuthorizeClassifierCopyAsync (options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="options"> Authorize copy request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Generates authorization to copy a document classifier to this location with
specified classifierId and optional description.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call AuthorizeClassifierCopyAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeClassifierCopyOptions authorizeCopyRequest = new AuthorizeClassifierCopyOptions("targetClassifier")
{
Description = "Target classifier description",
};
Response<ClassifierCopyAuthorization> response = await client.AuthorizeClassifierCopyAsync(authorizeCopyRequest);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeClassifierCopyAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AuthorizeClassifierCopyAsync (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> AuthorizeClassifierCopyAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeClassifierCopyAsync(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeClassifierCopyAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member AuthorizeClassifierCopyAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AuthorizeClassifierCopyAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentIntelligenceAdministrationClient.AuthorizeClassifierCopyAsync (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</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] Generates authorization to copy a document classifier to this location with
specified classifierId and optional description.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeClassifierCopyAsync(Azure.AI.DocumentIntelligence.AuthorizeClassifierCopyOptions,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 AuthorizeClassifierCopyAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
classifierId = "targetClassifier",
description = "Target classifier description",
});
Response response = await client.AuthorizeClassifierCopyAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("targetResourceId").ToString());
Console.WriteLine(result.GetProperty("targetResourceRegion").ToString());
Console.WriteLine(result.GetProperty("targetClassifierId").ToString());
Console.WriteLine(result.GetProperty("targetClassifierLocation").ToString());
Console.WriteLine(result.GetProperty("accessToken").ToString());
Console.WriteLine(result.GetProperty("expirationDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeModelCopy">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.CopyAuthorization> AuthorizeModelCopy (Azure.AI.DocumentIntelligence.AuthorizeCopyContent authorizeCopyRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.CopyAuthorization> AuthorizeModelCopy(class Azure.AI.DocumentIntelligence.AuthorizeCopyContent authorizeCopyRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeModelCopy(Azure.AI.DocumentIntelligence.AuthorizeCopyContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeModelCopy (authorizeCopyRequest As AuthorizeCopyContent, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CopyAuthorization)" />
<MemberSignature Language="F#" Value="abstract member AuthorizeModelCopy : Azure.AI.DocumentIntelligence.AuthorizeCopyContent * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.CopyAuthorization>
override this.AuthorizeModelCopy : Azure.AI.DocumentIntelligence.AuthorizeCopyContent * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.CopyAuthorization>" Usage="documentIntelligenceAdministrationClient.AuthorizeModelCopy (authorizeCopyRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.DocumentIntelligence.CopyAuthorization></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authorizeCopyRequest" Type="Azure.AI.DocumentIntelligence.AuthorizeCopyContent" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="authorizeCopyRequest"> Authorize copy request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Generates authorization to copy a document model to this location with
specified modelId and optional description.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="authorizeCopyRequest" /> is null. </exception>
<example>
This sample shows how to call AuthorizeModelCopy.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeCopyContent authorizeCopyRequest = new AuthorizeCopyContent("<modelId>");
Response<CopyAuthorization> response = client.AuthorizeModelCopy(authorizeCopyRequest);
]]></code>
This sample shows how to call AuthorizeModelCopy with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeCopyContent authorizeCopyRequest = new AuthorizeCopyContent("<modelId>")
{
Description = "<description>",
Tags =
{
["key"] = "<tags>"
},
};
Response<CopyAuthorization> response = client.AuthorizeModelCopy(authorizeCopyRequest);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeModelCopy">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.ModelCopyAuthorization> AuthorizeModelCopy (Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.ModelCopyAuthorization> AuthorizeModelCopy(class Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeModelCopy(Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeModelCopy (options As AuthorizeModelCopyOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ModelCopyAuthorization)" />
<MemberSignature Language="F#" Value="abstract member AuthorizeModelCopy : Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.ModelCopyAuthorization>
override this.AuthorizeModelCopy : Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.ModelCopyAuthorization>" Usage="documentIntelligenceAdministrationClient.AuthorizeModelCopy (options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.DocumentIntelligence.ModelCopyAuthorization></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="options"> Authorize copy request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Generates authorization to copy a document model to this location with
specified modelId and optional description.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call AuthorizeModelCopy.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeModelCopyOptions authorizeCopyRequest = new AuthorizeModelCopyOptions("targetModel")
{
Description = "Target model description",
};
Response<ModelCopyAuthorization> response = client.AuthorizeModelCopy(authorizeCopyRequest);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeModelCopy">
<MemberSignature Language="C#" Value="public virtual Azure.Response AuthorizeModelCopy (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AuthorizeModelCopy(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeModelCopy(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeModelCopy (content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member AuthorizeModelCopy : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AuthorizeModelCopy : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="documentIntelligenceAdministrationClient.AuthorizeModelCopy (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</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] Generates authorization to copy a document model to this location with
specified modelId and optional description.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeModelCopy(Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions,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 AuthorizeModelCopy and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
modelId = "targetModel",
description = "Target model description",
});
Response response = client.AuthorizeModelCopy(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("targetResourceId").ToString());
Console.WriteLine(result.GetProperty("targetResourceRegion").ToString());
Console.WriteLine(result.GetProperty("targetModelId").ToString());
Console.WriteLine(result.GetProperty("targetModelLocation").ToString());
Console.WriteLine(result.GetProperty("accessToken").ToString());
Console.WriteLine(result.GetProperty("expirationDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeModelCopyAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.CopyAuthorization>> AuthorizeModelCopyAsync (Azure.AI.DocumentIntelligence.AuthorizeCopyContent authorizeCopyRequest, 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.DocumentIntelligence.CopyAuthorization>> AuthorizeModelCopyAsync(class Azure.AI.DocumentIntelligence.AuthorizeCopyContent authorizeCopyRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeModelCopyAsync(Azure.AI.DocumentIntelligence.AuthorizeCopyContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeModelCopyAsync (authorizeCopyRequest As AuthorizeCopyContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CopyAuthorization))" />
<MemberSignature Language="F#" Value="abstract member AuthorizeModelCopyAsync : Azure.AI.DocumentIntelligence.AuthorizeCopyContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.CopyAuthorization>>
override this.AuthorizeModelCopyAsync : Azure.AI.DocumentIntelligence.AuthorizeCopyContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.CopyAuthorization>>" Usage="documentIntelligenceAdministrationClient.AuthorizeModelCopyAsync (authorizeCopyRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.CopyAuthorization>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authorizeCopyRequest" Type="Azure.AI.DocumentIntelligence.AuthorizeCopyContent" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="authorizeCopyRequest"> Authorize copy request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Generates authorization to copy a document model to this location with
specified modelId and optional description.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="authorizeCopyRequest" /> is null. </exception>
<example>
This sample shows how to call AuthorizeModelCopyAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeCopyContent authorizeCopyRequest = new AuthorizeCopyContent("<modelId>");
Response<CopyAuthorization> response = await client.AuthorizeModelCopyAsync(authorizeCopyRequest);
]]></code>
This sample shows how to call AuthorizeModelCopyAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeCopyContent authorizeCopyRequest = new AuthorizeCopyContent("<modelId>")
{
Description = "<description>",
Tags =
{
["key"] = "<tags>"
},
};
Response<CopyAuthorization> response = await client.AuthorizeModelCopyAsync(authorizeCopyRequest);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeModelCopyAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ModelCopyAuthorization>> AuthorizeModelCopyAsync (Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions options, 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.DocumentIntelligence.ModelCopyAuthorization>> AuthorizeModelCopyAsync(class Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeModelCopyAsync(Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeModelCopyAsync (options As AuthorizeModelCopyOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ModelCopyAuthorization))" />
<MemberSignature Language="F#" Value="abstract member AuthorizeModelCopyAsync : Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ModelCopyAuthorization>>
override this.AuthorizeModelCopyAsync : Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ModelCopyAuthorization>>" Usage="documentIntelligenceAdministrationClient.AuthorizeModelCopyAsync (options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ModelCopyAuthorization>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="options"> Authorize copy request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Generates authorization to copy a document model to this location with
specified modelId and optional description.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call AuthorizeModelCopyAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
AuthorizeModelCopyOptions authorizeCopyRequest = new AuthorizeModelCopyOptions("targetModel")
{
Description = "Target model description",
};
Response<ModelCopyAuthorization> response = await client.AuthorizeModelCopyAsync(authorizeCopyRequest);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AuthorizeModelCopyAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AuthorizeModelCopyAsync (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> AuthorizeModelCopyAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeModelCopyAsync(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AuthorizeModelCopyAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member AuthorizeModelCopyAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AuthorizeModelCopyAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentIntelligenceAdministrationClient.AuthorizeModelCopyAsync (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</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] Generates authorization to copy a document model to this location with
specified modelId and optional description.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.AuthorizeModelCopyAsync(Azure.AI.DocumentIntelligence.AuthorizeModelCopyOptions,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 AuthorizeModelCopyAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
modelId = "targetModel",
description = "Target model description",
});
Response response = await client.AuthorizeModelCopyAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("targetResourceId").ToString());
Console.WriteLine(result.GetProperty("targetResourceRegion").ToString());
Console.WriteLine(result.GetProperty("targetModelId").ToString());
Console.WriteLine(result.GetProperty("targetModelLocation").ToString());
Console.WriteLine(result.GetProperty("accessToken").ToString());
Console.WriteLine(result.GetProperty("expirationDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildClassifier">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails> BuildClassifier (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.BuildClassifierOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails> BuildClassifier(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.BuildClassifierOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildClassifier(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildClassifierOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildClassifier (waitUntil As WaitUntil, options As BuildClassifierOptions, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentClassifierDetails)" />
<MemberSignature Language="F#" Value="abstract member BuildClassifier : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildClassifierOptions * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>
override this.BuildClassifier : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildClassifierOptions * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>" Usage="documentIntelligenceAdministrationClient.BuildClassifier (waitUntil, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.BuildClassifierOptions" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</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="options"> Build request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Builds a custom document classifier. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call BuildClassifier.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildClassifierOptions buildRequest = new BuildClassifierOptions("myClassifier", new Dictionary<string, ClassifierDocumentTypeDetails>
{
["formA"] = new ClassifierDocumentTypeDetails(),
["formB"] = new ClassifierDocumentTypeDetails()
})
{
Description = "Classifier description",
};
Operation<DocumentClassifierDetails> operation = client.BuildClassifier(WaitUntil.Completed, buildRequest);
DocumentClassifierDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildClassifier">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails> BuildClassifier (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent buildRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails> BuildClassifier(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent buildRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildClassifier(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildClassifier (waitUntil As WaitUntil, buildRequest As BuildDocumentClassifierContent, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentClassifierDetails)" />
<MemberSignature Language="F#" Value="abstract member BuildClassifier : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>
override this.BuildClassifier : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>" Usage="documentIntelligenceAdministrationClient.BuildClassifier (waitUntil, buildRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="buildRequest" Type="Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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="buildRequest"> Build request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Builds a custom document classifier. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="buildRequest" /> is null. </exception>
<example>
This sample shows how to call BuildClassifier.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentClassifierContent buildRequest = new BuildDocumentClassifierContent("<classifierId>", new Dictionary<string, ClassifierDocumentTypeDetails>
{
["key"] = new ClassifierDocumentTypeDetails()
});
Operation<DocumentClassifierDetails> operation = client.BuildClassifier(WaitUntil.Completed, buildRequest);
DocumentClassifierDetails responseData = operation.Value;
]]></code>
This sample shows how to call BuildClassifier with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentClassifierContent buildRequest = new BuildDocumentClassifierContent("<classifierId>", new Dictionary<string, ClassifierDocumentTypeDetails>
{
["key"] = new ClassifierDocumentTypeDetails
{
SourceKind = ContentSourceKind.Url,
AzureBlobSource = new AzureBlobContentSource(new Uri("http://localhost:3000"))
{
Prefix = "<prefix>",
},
AzureBlobFileListSource = new AzureBlobFileListContentSource(new Uri("http://localhost:3000"), "<fileList>"),
}
})
{
Description = "<description>",
BaseClassifierId = "<baseClassifierId>",
AllowOverwrite = true,
};
Operation<DocumentClassifierDetails> operation = client.BuildClassifier(WaitUntil.Completed, buildRequest);
DocumentClassifierDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildClassifier">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> BuildClassifier (Azure.WaitUntil waitUntil, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> BuildClassifier(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildClassifier(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildClassifier (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member BuildClassifier : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.BuildClassifier : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="documentIntelligenceAdministrationClient.BuildClassifier (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="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] Builds a custom document classifier.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildClassifier(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildClassifierOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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: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 BuildClassifier and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
classifierId = "myClassifier",
description = "Classifier description",
docTypes = new
{
formA = new
{
azureBlobSource = new
{
containerUrl = "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
prefix = "formADocs/",
},
},
formB = new
{
azureBlobFileListSource = new
{
containerUrl = "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
fileList = "formB.jsonl",
},
},
},
});
Operation<BinaryData> operation = client.BuildClassifier(WaitUntil.Completed, content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("classifierId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("apiVersion").ToString());
Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildClassifierAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>> BuildClassifierAsync (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.BuildClassifierOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails>> BuildClassifierAsync(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.BuildClassifierOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildClassifierAsync(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildClassifierOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildClassifierAsync (waitUntil As WaitUntil, options As BuildClassifierOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentClassifierDetails))" />
<MemberSignature Language="F#" Value="abstract member BuildClassifierAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildClassifierOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>
override this.BuildClassifierAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildClassifierOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>" Usage="documentIntelligenceAdministrationClient.BuildClassifierAsync (waitUntil, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.BuildClassifierOptions" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</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="options"> Build request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Builds a custom document classifier. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call BuildClassifierAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildClassifierOptions buildRequest = new BuildClassifierOptions("myClassifier", new Dictionary<string, ClassifierDocumentTypeDetails>
{
["formA"] = new ClassifierDocumentTypeDetails(),
["formB"] = new ClassifierDocumentTypeDetails()
})
{
Description = "Classifier description",
};
Operation<DocumentClassifierDetails> operation = await client.BuildClassifierAsync(WaitUntil.Completed, buildRequest);
DocumentClassifierDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildClassifierAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>> BuildClassifierAsync (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent buildRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails>> BuildClassifierAsync(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent buildRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildClassifierAsync(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildClassifierAsync (waitUntil As WaitUntil, buildRequest As BuildDocumentClassifierContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentClassifierDetails))" />
<MemberSignature Language="F#" Value="abstract member BuildClassifierAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>
override this.BuildClassifierAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>" Usage="documentIntelligenceAdministrationClient.BuildClassifierAsync (waitUntil, buildRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="buildRequest" Type="Azure.AI.DocumentIntelligence.BuildDocumentClassifierContent" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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="buildRequest"> Build request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Builds a custom document classifier. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="buildRequest" /> is null. </exception>
<example>
This sample shows how to call BuildClassifierAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentClassifierContent buildRequest = new BuildDocumentClassifierContent("<classifierId>", new Dictionary<string, ClassifierDocumentTypeDetails>
{
["key"] = new ClassifierDocumentTypeDetails()
});
Operation<DocumentClassifierDetails> operation = await client.BuildClassifierAsync(WaitUntil.Completed, buildRequest);
DocumentClassifierDetails responseData = operation.Value;
]]></code>
This sample shows how to call BuildClassifierAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentClassifierContent buildRequest = new BuildDocumentClassifierContent("<classifierId>", new Dictionary<string, ClassifierDocumentTypeDetails>
{
["key"] = new ClassifierDocumentTypeDetails
{
SourceKind = ContentSourceKind.Url,
AzureBlobSource = new AzureBlobContentSource(new Uri("http://localhost:3000"))
{
Prefix = "<prefix>",
},
AzureBlobFileListSource = new AzureBlobFileListContentSource(new Uri("http://localhost:3000"), "<fileList>"),
}
})
{
Description = "<description>",
BaseClassifierId = "<baseClassifierId>",
AllowOverwrite = true,
};
Operation<DocumentClassifierDetails> operation = await client.BuildClassifierAsync(WaitUntil.Completed, buildRequest);
DocumentClassifierDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildClassifierAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> BuildClassifierAsync (Azure.WaitUntil waitUntil, 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.Operation`1<class System.BinaryData>> BuildClassifierAsync(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildClassifierAsync(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildClassifierAsync (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" />
<MemberSignature Language="F#" Value="abstract member BuildClassifierAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.BuildClassifierAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="documentIntelligenceAdministrationClient.BuildClassifierAsync (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="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] Builds a custom document classifier.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildClassifierAsync(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildClassifierOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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: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 BuildClassifierAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
classifierId = "myClassifier",
description = "Classifier description",
docTypes = new
{
formA = new
{
azureBlobSource = new
{
containerUrl = "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
prefix = "formADocs/",
},
},
formB = new
{
azureBlobFileListSource = new
{
containerUrl = "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
fileList = "formB.jsonl",
},
},
},
});
Operation<BinaryData> operation = await client.BuildClassifierAsync(WaitUntil.Completed, content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("classifierId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("apiVersion").ToString());
Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildDocumentModel">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails> BuildDocumentModel (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.BuildDocumentModelContent buildRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails> BuildDocumentModel(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.BuildDocumentModelContent buildRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildDocumentModel(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildDocumentModelContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildDocumentModel (waitUntil As WaitUntil, buildRequest As BuildDocumentModelContent, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentModelDetails)" />
<MemberSignature Language="F#" Value="abstract member BuildDocumentModel : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentModelContent * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.BuildDocumentModel : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentModelContent * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>" Usage="documentIntelligenceAdministrationClient.BuildDocumentModel (waitUntil, buildRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="buildRequest" Type="Azure.AI.DocumentIntelligence.BuildDocumentModelContent" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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="buildRequest"> Build request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Builds a custom document analysis model. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="buildRequest" /> is null. </exception>
<example>
This sample shows how to call BuildDocumentModel.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentModelContent buildRequest = new BuildDocumentModelContent("<modelId>", DocumentBuildMode.Template);
Operation<DocumentModelDetails> operation = client.BuildDocumentModel(WaitUntil.Completed, buildRequest);
DocumentModelDetails responseData = operation.Value;
]]></code>
This sample shows how to call BuildDocumentModel with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentModelContent buildRequest = new BuildDocumentModelContent("<modelId>", DocumentBuildMode.Template)
{
Description = "<description>",
AzureBlobSource = new AzureBlobContentSource(new Uri("http://localhost:3000"))
{
Prefix = "<prefix>",
},
AzureBlobFileListSource = new AzureBlobFileListContentSource(new Uri("http://localhost:3000"), "<fileList>"),
Tags =
{
["key"] = "<tags>"
},
MaxTrainingHours = 123.45F,
AllowOverwrite = true,
};
Operation<DocumentModelDetails> operation = client.BuildDocumentModel(WaitUntil.Completed, buildRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildDocumentModel">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails> BuildDocumentModel (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.BuildDocumentModelOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails> BuildDocumentModel(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.BuildDocumentModelOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildDocumentModel(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildDocumentModelOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildDocumentModel (waitUntil As WaitUntil, options As BuildDocumentModelOptions, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentModelDetails)" />
<MemberSignature Language="F#" Value="abstract member BuildDocumentModel : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentModelOptions * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.BuildDocumentModel : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentModelOptions * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>" Usage="documentIntelligenceAdministrationClient.BuildDocumentModel (waitUntil, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.BuildDocumentModelOptions" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</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="options"> Build request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Builds a custom document analysis model. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call BuildDocumentModel.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentModelOptions buildRequest = new BuildDocumentModelOptions("myCustomModel", DocumentBuildMode.Template)
{
Description = "Custom model description",
Tags =
{
["createdBy"] = "myUserId"
},
};
Operation<DocumentModelDetails> operation = client.BuildDocumentModel(WaitUntil.Completed, buildRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildDocumentModel">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> BuildDocumentModel (Azure.WaitUntil waitUntil, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> BuildDocumentModel(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildDocumentModel(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildDocumentModel (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member BuildDocumentModel : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.BuildDocumentModel : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="documentIntelligenceAdministrationClient.BuildDocumentModel (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="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] Builds a custom document analysis model.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildDocumentModel(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildDocumentModelOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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: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 BuildDocumentModel and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
modelId = "myCustomModel",
description = "Custom model description",
buildMode = "template",
azureBlobSource = new
{
containerUrl = "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
prefix = "trainingDocs/",
},
tags = new
{
createdBy = "myUserId",
},
});
Operation<BinaryData> operation = client.BuildDocumentModel(WaitUntil.Completed, content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildDocumentModelAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>> BuildDocumentModelAsync (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.BuildDocumentModelContent buildRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails>> BuildDocumentModelAsync(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.BuildDocumentModelContent buildRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildDocumentModelAsync(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildDocumentModelContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildDocumentModelAsync (waitUntil As WaitUntil, buildRequest As BuildDocumentModelContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentModelDetails))" />
<MemberSignature Language="F#" Value="abstract member BuildDocumentModelAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentModelContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>
override this.BuildDocumentModelAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentModelContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>" Usage="documentIntelligenceAdministrationClient.BuildDocumentModelAsync (waitUntil, buildRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="buildRequest" Type="Azure.AI.DocumentIntelligence.BuildDocumentModelContent" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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="buildRequest"> Build request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Builds a custom document analysis model. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="buildRequest" /> is null. </exception>
<example>
This sample shows how to call BuildDocumentModelAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentModelContent buildRequest = new BuildDocumentModelContent("<modelId>", DocumentBuildMode.Template);
Operation<DocumentModelDetails> operation = await client.BuildDocumentModelAsync(WaitUntil.Completed, buildRequest);
DocumentModelDetails responseData = operation.Value;
]]></code>
This sample shows how to call BuildDocumentModelAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentModelContent buildRequest = new BuildDocumentModelContent("<modelId>", DocumentBuildMode.Template)
{
Description = "<description>",
AzureBlobSource = new AzureBlobContentSource(new Uri("http://localhost:3000"))
{
Prefix = "<prefix>",
},
AzureBlobFileListSource = new AzureBlobFileListContentSource(new Uri("http://localhost:3000"), "<fileList>"),
Tags =
{
["key"] = "<tags>"
},
MaxTrainingHours = 123.45F,
AllowOverwrite = true,
};
Operation<DocumentModelDetails> operation = await client.BuildDocumentModelAsync(WaitUntil.Completed, buildRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildDocumentModelAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>> BuildDocumentModelAsync (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.BuildDocumentModelOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails>> BuildDocumentModelAsync(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.BuildDocumentModelOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildDocumentModelAsync(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildDocumentModelOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildDocumentModelAsync (waitUntil As WaitUntil, options As BuildDocumentModelOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentModelDetails))" />
<MemberSignature Language="F#" Value="abstract member BuildDocumentModelAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentModelOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>
override this.BuildDocumentModelAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.BuildDocumentModelOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>" Usage="documentIntelligenceAdministrationClient.BuildDocumentModelAsync (waitUntil, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.BuildDocumentModelOptions" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</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="options"> Build request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Builds a custom document analysis model. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call BuildDocumentModelAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
BuildDocumentModelOptions buildRequest = new BuildDocumentModelOptions("myCustomModel", DocumentBuildMode.Template)
{
Description = "Custom model description",
Tags =
{
["createdBy"] = "myUserId"
},
};
Operation<DocumentModelDetails> operation = await client.BuildDocumentModelAsync(WaitUntil.Completed, buildRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="BuildDocumentModelAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> BuildDocumentModelAsync (Azure.WaitUntil waitUntil, 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.Operation`1<class System.BinaryData>> BuildDocumentModelAsync(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildDocumentModelAsync(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function BuildDocumentModelAsync (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" />
<MemberSignature Language="F#" Value="abstract member BuildDocumentModelAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.BuildDocumentModelAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="documentIntelligenceAdministrationClient.BuildDocumentModelAsync (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="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] Builds a custom document analysis model.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.BuildDocumentModelAsync(Azure.WaitUntil,Azure.AI.DocumentIntelligence.BuildDocumentModelOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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: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 BuildDocumentModelAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
modelId = "myCustomModel",
description = "Custom model description",
buildMode = "template",
azureBlobSource = new
{
containerUrl = "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
prefix = "trainingDocs/",
},
tags = new
{
createdBy = "myUserId",
},
});
Operation<BinaryData> operation = await client.BuildDocumentModelAsync(WaitUntil.Completed, content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="ComposeModel">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails> ComposeModel (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.ComposeDocumentModelContent composeRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails> ComposeModel(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.ComposeDocumentModelContent composeRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.ComposeModel(Azure.WaitUntil,Azure.AI.DocumentIntelligence.ComposeDocumentModelContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ComposeModel (waitUntil As WaitUntil, composeRequest As ComposeDocumentModelContent, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentModelDetails)" />
<MemberSignature Language="F#" Value="abstract member ComposeModel : Azure.WaitUntil * Azure.AI.DocumentIntelligence.ComposeDocumentModelContent * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.ComposeModel : Azure.WaitUntil * Azure.AI.DocumentIntelligence.ComposeDocumentModelContent * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>" Usage="documentIntelligenceAdministrationClient.ComposeModel (waitUntil, composeRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="composeRequest" Type="Azure.AI.DocumentIntelligence.ComposeDocumentModelContent" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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="composeRequest"> Compose request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Creates a new document model from document types of existing document models. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="composeRequest" /> is null. </exception>
<example>
This sample shows how to call ComposeModel.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ComposeDocumentModelContent composeRequest = new ComposeDocumentModelContent("<modelId>", "<classifierId>", new Dictionary<string, DocumentTypeDetails>
{
["key"] = new DocumentTypeDetails()
});
Operation<DocumentModelDetails> operation = client.ComposeModel(WaitUntil.Completed, composeRequest);
DocumentModelDetails responseData = operation.Value;
]]></code>
This sample shows how to call ComposeModel with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ComposeDocumentModelContent composeRequest = new ComposeDocumentModelContent("<modelId>", "<classifierId>", new Dictionary<string, DocumentTypeDetails>
{
["key"] = new DocumentTypeDetails
{
Description = "<description>",
BuildMode = DocumentBuildMode.Template,
FieldSchema =
{
["key"] = new DocumentFieldSchema(DocumentFieldType.String)
{
Description = "<description>",
Example = "<example>",
Items = default,
Properties =
{
["key"] = default
},
}
},
FieldConfidence =
{
["key"] = 123.45F
},
ModelId = "<modelId>",
ConfidenceThreshold = 123.45F,
Features = { DocumentAnalysisFeature.OcrHighResolution },
QueryFields = { "<queryFields>" },
MaxDocumentsToAnalyze = 1234,
}
})
{
Description = "<description>",
Split = SplitMode.Auto,
Tags =
{
["key"] = "<tags>"
},
};
Operation<DocumentModelDetails> operation = client.ComposeModel(WaitUntil.Completed, composeRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="ComposeModel">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails> ComposeModel (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.ComposeModelOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails> ComposeModel(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.ComposeModelOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.ComposeModel(Azure.WaitUntil,Azure.AI.DocumentIntelligence.ComposeModelOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ComposeModel (waitUntil As WaitUntil, options As ComposeModelOptions, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentModelDetails)" />
<MemberSignature Language="F#" Value="abstract member ComposeModel : Azure.WaitUntil * Azure.AI.DocumentIntelligence.ComposeModelOptions * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.ComposeModel : Azure.WaitUntil * Azure.AI.DocumentIntelligence.ComposeModelOptions * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>" Usage="documentIntelligenceAdministrationClient.ComposeModel (waitUntil, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.ComposeModelOptions" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</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="options"> Compose request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Creates a new document model from document types of existing document models. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call ComposeModel.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ComposeModelOptions composeRequest = new ComposeModelOptions("composedModel", "customClassifier", new Dictionary<string, DocumentTypeDetails>
{
["formA"] = new DocumentTypeDetails
{
ModelId = "model1",
},
["formB"] = new DocumentTypeDetails
{
ModelId = "model2",
}
})
{
Description = "Composed model description",
};
Operation<DocumentModelDetails> operation = client.ComposeModel(WaitUntil.Completed, composeRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="ComposeModel">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> ComposeModel (Azure.WaitUntil waitUntil, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> ComposeModel(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.ComposeModel(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ComposeModel (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member ComposeModel : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.ComposeModel : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="documentIntelligenceAdministrationClient.ComposeModel (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="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] Creates a new document model from document types of existing document models.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.ComposeModel(Azure.WaitUntil,Azure.AI.DocumentIntelligence.ComposeModelOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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: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 ComposeModel and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
modelId = "composedModel",
description = "Composed model description",
classifierId = "customClassifier",
docTypes = new
{
formA = new
{
modelId = "model1",
},
formB = new
{
modelId = "model2",
},
},
});
Operation<BinaryData> operation = client.ComposeModel(WaitUntil.Completed, content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="ComposeModelAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>> ComposeModelAsync (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.ComposeDocumentModelContent composeRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails>> ComposeModelAsync(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.ComposeDocumentModelContent composeRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.ComposeModelAsync(Azure.WaitUntil,Azure.AI.DocumentIntelligence.ComposeDocumentModelContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ComposeModelAsync (waitUntil As WaitUntil, composeRequest As ComposeDocumentModelContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentModelDetails))" />
<MemberSignature Language="F#" Value="abstract member ComposeModelAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.ComposeDocumentModelContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>
override this.ComposeModelAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.ComposeDocumentModelContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>" Usage="documentIntelligenceAdministrationClient.ComposeModelAsync (waitUntil, composeRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="composeRequest" Type="Azure.AI.DocumentIntelligence.ComposeDocumentModelContent" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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="composeRequest"> Compose request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Creates a new document model from document types of existing document models. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="composeRequest" /> is null. </exception>
<example>
This sample shows how to call ComposeModelAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ComposeDocumentModelContent composeRequest = new ComposeDocumentModelContent("<modelId>", "<classifierId>", new Dictionary<string, DocumentTypeDetails>
{
["key"] = new DocumentTypeDetails()
});
Operation<DocumentModelDetails> operation = await client.ComposeModelAsync(WaitUntil.Completed, composeRequest);
DocumentModelDetails responseData = operation.Value;
]]></code>
This sample shows how to call ComposeModelAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ComposeDocumentModelContent composeRequest = new ComposeDocumentModelContent("<modelId>", "<classifierId>", new Dictionary<string, DocumentTypeDetails>
{
["key"] = new DocumentTypeDetails
{
Description = "<description>",
BuildMode = DocumentBuildMode.Template,
FieldSchema =
{
["key"] = new DocumentFieldSchema(DocumentFieldType.String)
{
Description = "<description>",
Example = "<example>",
Items = default,
Properties =
{
["key"] = default
},
}
},
FieldConfidence =
{
["key"] = 123.45F
},
ModelId = "<modelId>",
ConfidenceThreshold = 123.45F,
Features = { DocumentAnalysisFeature.OcrHighResolution },
QueryFields = { "<queryFields>" },
MaxDocumentsToAnalyze = 1234,
}
})
{
Description = "<description>",
Split = SplitMode.Auto,
Tags =
{
["key"] = "<tags>"
},
};
Operation<DocumentModelDetails> operation = await client.ComposeModelAsync(WaitUntil.Completed, composeRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="ComposeModelAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>> ComposeModelAsync (Azure.WaitUntil waitUntil, Azure.AI.DocumentIntelligence.ComposeModelOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails>> ComposeModelAsync(valuetype Azure.WaitUntil waitUntil, class Azure.AI.DocumentIntelligence.ComposeModelOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.ComposeModelAsync(Azure.WaitUntil,Azure.AI.DocumentIntelligence.ComposeModelOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ComposeModelAsync (waitUntil As WaitUntil, options As ComposeModelOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentModelDetails))" />
<MemberSignature Language="F#" Value="abstract member ComposeModelAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.ComposeModelOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>
override this.ComposeModelAsync : Azure.WaitUntil * Azure.AI.DocumentIntelligence.ComposeModelOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>" Usage="documentIntelligenceAdministrationClient.ComposeModelAsync (waitUntil, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="options" Type="Azure.AI.DocumentIntelligence.ComposeModelOptions" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</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="options"> Compose request options. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Creates a new document model from document types of existing document models. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null. </exception>
<example>
This sample shows how to call ComposeModelAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ComposeModelOptions composeRequest = new ComposeModelOptions("composedModel", "customClassifier", new Dictionary<string, DocumentTypeDetails>
{
["formA"] = new DocumentTypeDetails
{
ModelId = "model1",
},
["formB"] = new DocumentTypeDetails
{
ModelId = "model2",
}
})
{
Description = "Composed model description",
};
Operation<DocumentModelDetails> operation = await client.ComposeModelAsync(WaitUntil.Completed, composeRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="ComposeModelAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> ComposeModelAsync (Azure.WaitUntil waitUntil, 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.Operation`1<class System.BinaryData>> ComposeModelAsync(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.ComposeModelAsync(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ComposeModelAsync (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" />
<MemberSignature Language="F#" Value="abstract member ComposeModelAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.ComposeModelAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="documentIntelligenceAdministrationClient.ComposeModelAsync (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="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] Creates a new document model from document types of existing document models.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.ComposeModelAsync(Azure.WaitUntil,Azure.AI.DocumentIntelligence.ComposeModelOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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: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 ComposeModelAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
modelId = "composedModel",
description = "Composed model description",
classifierId = "customClassifier",
docTypes = new
{
formA = new
{
modelId = "model1",
},
formB = new
{
modelId = "model2",
},
},
});
Operation<BinaryData> operation = await client.ComposeModelAsync(WaitUntil.Completed, content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyClassifierTo">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> CopyClassifierTo (Azure.WaitUntil waitUntil, string classifierId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> CopyClassifierTo(valuetype Azure.WaitUntil waitUntil, string classifierId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyClassifierTo(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyClassifierTo (waitUntil As WaitUntil, classifierId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member CopyClassifierTo : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.CopyClassifierTo : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="documentIntelligenceAdministrationClient.CopyClassifierTo (waitUntil, classifierId, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="classifierId"> Unique document classifier name. </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] Copies document classifier to the target resource, region, and classifierId.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyClassifierTo(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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:System.ArgumentNullException">
<paramref name="classifierId" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CopyClassifierTo and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
targetResourceId = "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
targetResourceRegion = "targetResourceRegion",
targetClassifierId = "targetClassifier",
targetClassifierLocation = "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/targetClassifier",
accessToken = "accessToken",
expirationDateTime = "2021-09-23T09:12:54.552Z",
});
Operation<BinaryData> operation = client.CopyClassifierTo(WaitUntil.Completed, "sourceClassifier", content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("classifierId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("apiVersion").ToString());
Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyClassifierTo">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails> CopyClassifierTo (Azure.WaitUntil waitUntil, string classifierId, Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization authorization, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails> CopyClassifierTo(valuetype Azure.WaitUntil waitUntil, string classifierId, class Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization authorization, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyClassifierTo(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyClassifierTo (waitUntil As WaitUntil, classifierId As String, authorization As ClassifierCopyAuthorization, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentClassifierDetails)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="abstract member CopyClassifierTo : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>
override this.CopyClassifierTo : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>" Usage="documentIntelligenceAdministrationClient.CopyClassifierTo (waitUntil, classifierId, authorization, cancellationToken)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails> CopyClassifierTo (Azure.WaitUntil waitUntil, string classifierId, Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization copyToRequest, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails> CopyClassifierTo(valuetype Azure.WaitUntil waitUntil, string classifierId, class Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization copyToRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyClassifierTo (waitUntil As WaitUntil, classifierId As String, copyToRequest As ClassifierCopyAuthorization, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentClassifierDetails)" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="abstract member CopyClassifierTo : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>
override this.CopyClassifierTo : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>" Usage="documentIntelligenceAdministrationClient.CopyClassifierTo (waitUntil, classifierId, copyToRequest, cancellationToken)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" />
<Parameter Name="classifierId" Type="System.String" Index="1" />
<Parameter Name="authorization" Type="Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="copyToRequest" Type="Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" />
</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="classifierId"> Unique document classifier name. </param>
<param name="authorization"> Copy to request authorization. </param>
<param name="copyToRequest"> Copy to request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Copies document classifier to the target resource, region, and classifierId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="classifierId" /> or <paramref name="authorization" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CopyClassifierTo.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ClassifierCopyAuthorization copyToRequest = new ClassifierCopyAuthorization(
"/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
"targetResourceRegion",
"targetClassifier",
new Uri("https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/targetClassifier"),
"accessToken",
DateTimeOffset.Parse("2021-09-23T09:12:54.552Z"));
Operation<DocumentClassifierDetails> operation = client.CopyClassifierTo(WaitUntil.Completed, "sourceClassifier", copyToRequest);
DocumentClassifierDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyClassifierToAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> CopyClassifierToAsync (Azure.WaitUntil waitUntil, string classifierId, 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.Operation`1<class System.BinaryData>> CopyClassifierToAsync(valuetype Azure.WaitUntil waitUntil, string classifierId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyClassifierToAsync(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyClassifierToAsync (waitUntil As WaitUntil, classifierId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" />
<MemberSignature Language="F#" Value="abstract member CopyClassifierToAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.CopyClassifierToAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="documentIntelligenceAdministrationClient.CopyClassifierToAsync (waitUntil, classifierId, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="classifierId"> Unique document classifier name. </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] Copies document classifier to the target resource, region, and classifierId.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyClassifierToAsync(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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:System.ArgumentNullException">
<paramref name="classifierId" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CopyClassifierToAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
targetResourceId = "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
targetResourceRegion = "targetResourceRegion",
targetClassifierId = "targetClassifier",
targetClassifierLocation = "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/targetClassifier",
accessToken = "accessToken",
expirationDateTime = "2021-09-23T09:12:54.552Z",
});
Operation<BinaryData> operation = await client.CopyClassifierToAsync(WaitUntil.Completed, "sourceClassifier", content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("classifierId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("apiVersion").ToString());
Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyClassifierToAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>> CopyClassifierToAsync (Azure.WaitUntil waitUntil, string classifierId, Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization authorization, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails>> CopyClassifierToAsync(valuetype Azure.WaitUntil waitUntil, string classifierId, class Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization authorization, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyClassifierToAsync(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyClassifierToAsync (waitUntil As WaitUntil, classifierId As String, authorization As ClassifierCopyAuthorization, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentClassifierDetails))" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="abstract member CopyClassifierToAsync : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>
override this.CopyClassifierToAsync : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>" Usage="documentIntelligenceAdministrationClient.CopyClassifierToAsync (waitUntil, classifierId, authorization, cancellationToken)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>> CopyClassifierToAsync (Azure.WaitUntil waitUntil, string classifierId, Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization copyToRequest, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails>> CopyClassifierToAsync(valuetype Azure.WaitUntil waitUntil, string classifierId, class Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization copyToRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyClassifierToAsync (waitUntil As WaitUntil, classifierId As String, copyToRequest As ClassifierCopyAuthorization, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentClassifierDetails))" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="abstract member CopyClassifierToAsync : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>
override this.CopyClassifierToAsync : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>" Usage="documentIntelligenceAdministrationClient.CopyClassifierToAsync (waitUntil, classifierId, copyToRequest, cancellationToken)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" />
<Parameter Name="classifierId" Type="System.String" Index="1" />
<Parameter Name="authorization" Type="Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="copyToRequest" Type="Azure.AI.DocumentIntelligence.ClassifierCopyAuthorization" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" />
</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="classifierId"> Unique document classifier name. </param>
<param name="authorization"> Copy to request authorization. </param>
<param name="copyToRequest"> Copy to request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Copies document classifier to the target resource, region, and classifierId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="classifierId" /> or <paramref name="authorization" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CopyClassifierToAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ClassifierCopyAuthorization copyToRequest = new ClassifierCopyAuthorization(
"/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
"targetResourceRegion",
"targetClassifier",
new Uri("https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/targetClassifier"),
"accessToken",
DateTimeOffset.Parse("2021-09-23T09:12:54.552Z"));
Operation<DocumentClassifierDetails> operation = await client.CopyClassifierToAsync(WaitUntil.Completed, "sourceClassifier", copyToRequest);
DocumentClassifierDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyModelTo">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails> CopyModelTo (Azure.WaitUntil waitUntil, string modelId, Azure.AI.DocumentIntelligence.CopyAuthorization copyToRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails> CopyModelTo(valuetype Azure.WaitUntil waitUntil, string modelId, class Azure.AI.DocumentIntelligence.CopyAuthorization copyToRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyModelTo(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.CopyAuthorization,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyModelTo (waitUntil As WaitUntil, modelId As String, copyToRequest As CopyAuthorization, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentModelDetails)" />
<MemberSignature Language="F#" Value="abstract member CopyModelTo : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.CopyAuthorization * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.CopyModelTo : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.CopyAuthorization * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>" Usage="documentIntelligenceAdministrationClient.CopyModelTo (waitUntil, modelId, copyToRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="modelId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="copyToRequest" Type="Azure.AI.DocumentIntelligence.CopyAuthorization" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="azure-dotnet-preview" />
</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="modelId"> Unique document model name. </param>
<param name="copyToRequest"> Copy to request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Copies document model to the target resource, region, and modelId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="modelId" /> or <paramref name="copyToRequest" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CopyModelTo.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
CopyAuthorization copyToRequest = new CopyAuthorization(
"<targetResourceId>",
"<targetResourceRegion>",
"<targetModelId>",
new Uri("http://localhost:3000"),
"<accessToken>",
DateTimeOffset.Parse("2022-05-10T18:57:31.2311892Z"));
Operation<DocumentModelDetails> operation = client.CopyModelTo(WaitUntil.Completed, "<modelId>", copyToRequest);
DocumentModelDetails responseData = operation.Value;
]]></code>
This sample shows how to call CopyModelTo with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
CopyAuthorization copyToRequest = new CopyAuthorization(
"<targetResourceId>",
"<targetResourceRegion>",
"<targetModelId>",
new Uri("http://localhost:3000"),
"<accessToken>",
DateTimeOffset.Parse("2022-05-10T18:57:31.2311892Z"));
Operation<DocumentModelDetails> operation = client.CopyModelTo(WaitUntil.Completed, "<modelId>", copyToRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyModelTo">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails> CopyModelTo (Azure.WaitUntil waitUntil, string modelId, Azure.AI.DocumentIntelligence.ModelCopyAuthorization authorization, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails> CopyModelTo(valuetype Azure.WaitUntil waitUntil, string modelId, class Azure.AI.DocumentIntelligence.ModelCopyAuthorization authorization, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyModelTo(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.ModelCopyAuthorization,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyModelTo (waitUntil As WaitUntil, modelId As String, authorization As ModelCopyAuthorization, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DocumentModelDetails)" />
<MemberSignature Language="F#" Value="abstract member CopyModelTo : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ModelCopyAuthorization * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.CopyModelTo : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ModelCopyAuthorization * System.Threading.CancellationToken -> Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>" Usage="documentIntelligenceAdministrationClient.CopyModelTo (waitUntil, modelId, authorization, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="modelId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="authorization" Type="Azure.AI.DocumentIntelligence.ModelCopyAuthorization" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="azure-dotnet" />
</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="modelId"> Unique document model name. </param>
<param name="authorization"> Copy to request authorization. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Copies document model to the target resource, region, and modelId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="modelId" /> or <paramref name="authorization" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CopyModelTo.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ModelCopyAuthorization copyToRequest = new ModelCopyAuthorization(
"/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
"targetResourceRegion",
"targetModel",
new Uri("https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentModels/targetModel"),
"accessToken",
DateTimeOffset.Parse("2021-09-23T09:12:54.552Z"));
Operation<DocumentModelDetails> operation = client.CopyModelTo(WaitUntil.Completed, "sourceModel", copyToRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyModelTo">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> CopyModelTo (Azure.WaitUntil waitUntil, string modelId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> CopyModelTo(valuetype Azure.WaitUntil waitUntil, string modelId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyModelTo(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyModelTo (waitUntil As WaitUntil, modelId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member CopyModelTo : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.CopyModelTo : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="documentIntelligenceAdministrationClient.CopyModelTo (waitUntil, modelId, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="modelId"> Unique document model name. </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] Copies document model to the target resource, region, and modelId.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyModelTo(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.ModelCopyAuthorization,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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:System.ArgumentNullException">
<paramref name="modelId" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CopyModelTo and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
targetResourceId = "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
targetResourceRegion = "targetResourceRegion",
targetModelId = "targetModel",
targetModelLocation = "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentModels/targetModel",
accessToken = "accessToken",
expirationDateTime = "2021-09-23T09:12:54.552Z",
});
Operation<BinaryData> operation = client.CopyModelTo(WaitUntil.Completed, "sourceModel", content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyModelToAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>> CopyModelToAsync (Azure.WaitUntil waitUntil, string modelId, Azure.AI.DocumentIntelligence.CopyAuthorization copyToRequest, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails>> CopyModelToAsync(valuetype Azure.WaitUntil waitUntil, string modelId, class Azure.AI.DocumentIntelligence.CopyAuthorization copyToRequest, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyModelToAsync(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.CopyAuthorization,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyModelToAsync (waitUntil As WaitUntil, modelId As String, copyToRequest As CopyAuthorization, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentModelDetails))" />
<MemberSignature Language="F#" Value="abstract member CopyModelToAsync : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.CopyAuthorization * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>
override this.CopyModelToAsync : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.CopyAuthorization * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>" Usage="documentIntelligenceAdministrationClient.CopyModelToAsync (waitUntil, modelId, copyToRequest, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="modelId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="copyToRequest" Type="Azure.AI.DocumentIntelligence.CopyAuthorization" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="azure-dotnet-preview" />
</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="modelId"> Unique document model name. </param>
<param name="copyToRequest"> Copy to request parameters. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Copies document model to the target resource, region, and modelId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="modelId" /> or <paramref name="copyToRequest" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CopyModelToAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
CopyAuthorization copyToRequest = new CopyAuthorization(
"<targetResourceId>",
"<targetResourceRegion>",
"<targetModelId>",
new Uri("http://localhost:3000"),
"<accessToken>",
DateTimeOffset.Parse("2022-05-10T18:57:31.2311892Z"));
Operation<DocumentModelDetails> operation = await client.CopyModelToAsync(WaitUntil.Completed, "<modelId>", copyToRequest);
DocumentModelDetails responseData = operation.Value;
]]></code>
This sample shows how to call CopyModelToAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
CopyAuthorization copyToRequest = new CopyAuthorization(
"<targetResourceId>",
"<targetResourceRegion>",
"<targetModelId>",
new Uri("http://localhost:3000"),
"<accessToken>",
DateTimeOffset.Parse("2022-05-10T18:57:31.2311892Z"));
Operation<DocumentModelDetails> operation = await client.CopyModelToAsync(WaitUntil.Completed, "<modelId>", copyToRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyModelToAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>> CopyModelToAsync (Azure.WaitUntil waitUntil, string modelId, Azure.AI.DocumentIntelligence.ModelCopyAuthorization authorization, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails>> CopyModelToAsync(valuetype Azure.WaitUntil waitUntil, string modelId, class Azure.AI.DocumentIntelligence.ModelCopyAuthorization authorization, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyModelToAsync(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.ModelCopyAuthorization,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyModelToAsync (waitUntil As WaitUntil, modelId As String, authorization As ModelCopyAuthorization, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DocumentModelDetails))" />
<MemberSignature Language="F#" Value="abstract member CopyModelToAsync : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ModelCopyAuthorization * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>
override this.CopyModelToAsync : Azure.WaitUntil * string * Azure.AI.DocumentIntelligence.ModelCopyAuthorization * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>>" Usage="documentIntelligenceAdministrationClient.CopyModelToAsync (waitUntil, modelId, authorization, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.AI.DocumentIntelligence.DocumentModelDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="modelId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="authorization" Type="Azure.AI.DocumentIntelligence.ModelCopyAuthorization" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="azure-dotnet" />
</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="modelId"> Unique document model name. </param>
<param name="authorization"> Copy to request authorization. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Copies document model to the target resource, region, and modelId. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="modelId" /> or <paramref name="authorization" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CopyModelToAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
ModelCopyAuthorization copyToRequest = new ModelCopyAuthorization(
"/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
"targetResourceRegion",
"targetModel",
new Uri("https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentModels/targetModel"),
"accessToken",
DateTimeOffset.Parse("2021-09-23T09:12:54.552Z"));
Operation<DocumentModelDetails> operation = await client.CopyModelToAsync(WaitUntil.Completed, "sourceModel", copyToRequest);
DocumentModelDetails responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="CopyModelToAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> CopyModelToAsync (Azure.WaitUntil waitUntil, string modelId, 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.Operation`1<class System.BinaryData>> CopyModelToAsync(valuetype Azure.WaitUntil waitUntil, string modelId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyModelToAsync(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CopyModelToAsync (waitUntil As WaitUntil, modelId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" />
<MemberSignature Language="F#" Value="abstract member CopyModelToAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.CopyModelToAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="documentIntelligenceAdministrationClient.CopyModelToAsync (waitUntil, modelId, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<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="modelId"> Unique document model name. </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] Copies document model to the target resource, region, and modelId.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.CopyModelToAsync(Azure.WaitUntil,System.String,Azure.AI.DocumentIntelligence.ModelCopyAuthorization,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</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:System.ArgumentNullException">
<paramref name="modelId" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CopyModelToAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
targetResourceId = "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
targetResourceRegion = "targetResourceRegion",
targetModelId = "targetModel",
targetModelLocation = "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentModels/targetModel",
accessToken = "accessToken",
expirationDateTime = "2021-09-23T09:12:54.552Z",
});
Operation<BinaryData> operation = await client.CopyModelToAsync(WaitUntil.Completed, "sourceModel", content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteClassifier">
<MemberSignature Language="C#" Value="public virtual Azure.Response DeleteClassifier (string classifierId, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DeleteClassifier(string classifierId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.DeleteClassifier(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteClassifier (classifierId As String, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member DeleteClassifier : string * Azure.RequestContext -> Azure.Response
override this.DeleteClassifier : string * Azure.RequestContext -> Azure.Response" Usage="documentIntelligenceAdministrationClient.DeleteClassifier (classifierId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="classifierId"> Unique document classifier name. </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] Deletes document classifier.
<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="classifierId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteClassifier.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = client.DeleteClassifier("myClassifier");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteClassifierAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteClassifierAsync (string classifierId, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteClassifierAsync(string classifierId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.DeleteClassifierAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteClassifierAsync (classifierId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member DeleteClassifierAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteClassifierAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentIntelligenceAdministrationClient.DeleteClassifierAsync (classifierId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="classifierId"> Unique document classifier name. </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] Deletes document classifier.
<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="classifierId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteClassifierAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = await client.DeleteClassifierAsync("myClassifier");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteModel">
<MemberSignature Language="C#" Value="public virtual Azure.Response DeleteModel (string modelId, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DeleteModel(string modelId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.DeleteModel(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteModel (modelId As String, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member DeleteModel : string * Azure.RequestContext -> Azure.Response
override this.DeleteModel : string * Azure.RequestContext -> Azure.Response" Usage="documentIntelligenceAdministrationClient.DeleteModel (modelId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="modelId"> Unique document model name. </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] Deletes document model.
<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="modelId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteModel.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = client.DeleteModel("myCustomModel");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteModelAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteModelAsync (string modelId, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteModelAsync(string modelId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.DeleteModelAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteModelAsync (modelId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member DeleteModelAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteModelAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentIntelligenceAdministrationClient.DeleteModelAsync (modelId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="modelId"> Unique document model name. </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] Deletes document model.
<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="modelId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteModelAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = await client.DeleteModelAsync("myCustomModel");
Console.WriteLine(response.Status);
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetClassifier">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetClassifier (string classifierId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetClassifier(string classifierId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifier(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifier (classifierId As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetClassifier : string * Azure.RequestContext -> Azure.Response
override this.GetClassifier : string * Azure.RequestContext -> Azure.Response" Usage="documentIntelligenceAdministrationClient.GetClassifier (classifierId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="classifierId"> Unique document classifier name. </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] Gets detailed document classifier information.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifier(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="classifierId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetClassifier and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = client.GetClassifier("myClassifier", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("classifierId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("apiVersion").ToString());
Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetClassifier">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.DocumentClassifierDetails> GetClassifier (string classifierId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails> GetClassifier(string classifierId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifier(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifier (classifierId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DocumentClassifierDetails)" />
<MemberSignature Language="F#" Value="abstract member GetClassifier : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>
override this.GetClassifier : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>" Usage="documentIntelligenceAdministrationClient.GetClassifier (classifierId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.DocumentIntelligence.DocumentClassifierDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="classifierId"> Unique document classifier name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets detailed document classifier information. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="classifierId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetClassifier.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentClassifierDetails> response = client.GetClassifier("myClassifier");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetClassifierAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetClassifierAsync (string classifierId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetClassifierAsync(string classifierId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifierAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifierAsync (classifierId As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetClassifierAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetClassifierAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentIntelligenceAdministrationClient.GetClassifierAsync (classifierId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="classifierId"> Unique document classifier name. </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] Gets detailed document classifier information.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifierAsync(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="classifierId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetClassifierAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = await client.GetClassifierAsync("myClassifier", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("classifierId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("apiVersion").ToString());
Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetClassifierAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>> GetClassifierAsync (string classifierId, 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.DocumentIntelligence.DocumentClassifierDetails>> GetClassifierAsync(string classifierId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifierAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifierAsync (classifierId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DocumentClassifierDetails))" />
<MemberSignature Language="F#" Value="abstract member GetClassifierAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>
override this.GetClassifierAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>>" Usage="documentIntelligenceAdministrationClient.GetClassifierAsync (classifierId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="classifierId"> Unique document classifier name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets detailed document classifier information. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="classifierId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="classifierId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetClassifierAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentClassifierDetails> response = await client.GetClassifierAsync("myClassifier");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetClassifiers">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetClassifiers (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetClassifiers(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifiers(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifiers (context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetClassifiers : Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetClassifiers : Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="documentIntelligenceAdministrationClient.GetClassifiers context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></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] List all document classifiers.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifiers(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </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 GetClassifiers and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
foreach (BinaryData item in client.GetClassifiers(null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("classifierId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("apiVersion").ToString());
Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetClassifiers">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentClassifierDetails> GetClassifiers (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails> GetClassifiers(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifiers(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifiers (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DocumentClassifierDetails)" />
<MemberSignature Language="F#" Value="abstract member GetClassifiers : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>
override this.GetClassifiers : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>" Usage="documentIntelligenceAdministrationClient.GetClassifiers cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentClassifierDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> List all document classifiers. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetClassifiers.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
foreach (DocumentClassifierDetails item in client.GetClassifiers())
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetClassifiersAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetClassifiersAsync (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetClassifiersAsync(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifiersAsync(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifiersAsync (context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetClassifiersAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetClassifiersAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="documentIntelligenceAdministrationClient.GetClassifiersAsync context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></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] List all document classifiers.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifiersAsync(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </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 GetClassifiersAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
await foreach (BinaryData item in client.GetClassifiersAsync(null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("classifierId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("apiVersion").ToString());
Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetClassifiersAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentClassifierDetails> GetClassifiersAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.AI.DocumentIntelligence.DocumentClassifierDetails> GetClassifiersAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetClassifiersAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifiersAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DocumentClassifierDetails)" />
<MemberSignature Language="F#" Value="abstract member GetClassifiersAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>
override this.GetClassifiersAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentClassifierDetails>" Usage="documentIntelligenceAdministrationClient.GetClassifiersAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentClassifierDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> List all document classifiers. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetClassifiersAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
await foreach (DocumentClassifierDetails item in client.GetClassifiersAsync())
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetModel">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetModel (string modelId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetModel(string modelId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModel(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetModel (modelId As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetModel : string * Azure.RequestContext -> Azure.Response
override this.GetModel : string * Azure.RequestContext -> Azure.Response" Usage="documentIntelligenceAdministrationClient.GetModel (modelId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="modelId"> Unique document model name. </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] Gets detailed document model information.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModel(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="modelId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetModel and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = client.GetModel("myCustomModel", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code>
This sample shows how to call GetModel and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = client.GetModel("prebuilt-invoice", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetModel">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.DocumentModelDetails> GetModel (string modelId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails> GetModel(string modelId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModel(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetModel (modelId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DocumentModelDetails)" />
<MemberSignature Language="F#" Value="abstract member GetModel : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.GetModel : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.DocumentModelDetails>" Usage="documentIntelligenceAdministrationClient.GetModel (modelId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.DocumentIntelligence.DocumentModelDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="modelId"> Unique document model name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets detailed document model information. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="modelId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetModel.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentModelDetails> response = client.GetModel("myCustomModel");
]]></code>
This sample shows how to call GetModel.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentModelDetails> response = client.GetModel("prebuilt-invoice");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetModelAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetModelAsync (string modelId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetModelAsync(string modelId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModelAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetModelAsync (modelId As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetModelAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetModelAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentIntelligenceAdministrationClient.GetModelAsync (modelId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="modelId"> Unique document model name. </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] Gets detailed document model information.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModelAsync(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="modelId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetModelAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = await client.GetModelAsync("myCustomModel", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code>
This sample shows how to call GetModelAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = await client.GetModelAsync("prebuilt-invoice", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetModelAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentModelDetails>> GetModelAsync (string modelId, 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.DocumentIntelligence.DocumentModelDetails>> GetModelAsync(string modelId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModelAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetModelAsync (modelId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DocumentModelDetails))" />
<MemberSignature Language="F#" Value="abstract member GetModelAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentModelDetails>>
override this.GetModelAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentModelDetails>>" Usage="documentIntelligenceAdministrationClient.GetModelAsync (modelId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentModelDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="modelId"> Unique document model name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets detailed document model information. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="modelId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="modelId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetModelAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentModelDetails> response = await client.GetModelAsync("myCustomModel");
]]></code>
This sample shows how to call GetModelAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentModelDetails> response = await client.GetModelAsync("prebuilt-invoice");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetModels">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetModels (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetModels(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModels(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetModels (context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetModels : Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetModels : Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="documentIntelligenceAdministrationClient.GetModels context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></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] List all document models
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModels(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </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 GetModels and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
foreach (BinaryData item in client.GetModels(null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetModels">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentModelDetails> GetModels (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails> GetModels(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModels(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetModels (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DocumentModelDetails)" />
<MemberSignature Language="F#" Value="abstract member GetModels : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.GetModels : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentModelDetails>" Usage="documentIntelligenceAdministrationClient.GetModels cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentModelDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> List all document models. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetModels.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
foreach (DocumentModelDetails item in client.GetModels())
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetModelsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetModelsAsync (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetModelsAsync(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModelsAsync(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetModelsAsync (context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetModelsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetModelsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="documentIntelligenceAdministrationClient.GetModelsAsync context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></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] List all document models
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModelsAsync(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </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 GetModelsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
await foreach (BinaryData item in client.GetModelsAsync(null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetModelsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentModelDetails> GetModelsAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.AI.DocumentIntelligence.DocumentModelDetails> GetModelsAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetModelsAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetModelsAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DocumentModelDetails)" />
<MemberSignature Language="F#" Value="abstract member GetModelsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.GetModelsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentModelDetails>" Usage="documentIntelligenceAdministrationClient.GetModelsAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentModelDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> List all document models. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetModelsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
await foreach (DocumentModelDetails item in client.GetModelsAsync())
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetOperation">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetOperation (string operationId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetOperation(string operationId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperation(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperation (operationId As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetOperation : string * Azure.RequestContext -> Azure.Response
override this.GetOperation : string * Azure.RequestContext -> Azure.Response" Usage="documentIntelligenceAdministrationClient.GetOperation (operationId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operationId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="operationId"> Operation ID. </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] Gets operation info.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperation(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="operationId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="operationId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetOperation and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = client.GetOperation("b704bb00-d130-4f3f-a1d8-ca96de3eabb4", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("operationId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("resourceLocation").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetOperation">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails> GetOperation (string operationId, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails> GetOperation(string operationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperation(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperation (operationId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DocumentIntelligenceOperationDetails)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="abstract member GetOperation : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>
override this.GetOperation : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>" Usage="documentIntelligenceAdministrationClient.GetOperation (operationId, cancellationToken)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.OperationDetails> GetOperation (string operationId, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.OperationDetails> GetOperation(string operationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperation (operationId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of OperationDetails)" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="abstract member GetOperation : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.OperationDetails>
override this.GetOperation : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.OperationDetails>" Usage="documentIntelligenceAdministrationClient.GetOperation (operationId, cancellationToken)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType FrameworkAlternate="azure-dotnet">Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails></ReturnType>
<ReturnType FrameworkAlternate="azure-dotnet-preview">Azure.Response<Azure.AI.DocumentIntelligence.OperationDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operationId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operationId"> Operation ID. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets operation info. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="operationId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="operationId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentIntelligenceOperationDetails> response = client.GetOperation("b704bb00-d130-4f3f-a1d8-ca96de3eabb4");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetOperationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetOperationAsync (string operationId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetOperationAsync(string operationId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperationAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperationAsync (operationId As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetOperationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetOperationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentIntelligenceAdministrationClient.GetOperationAsync (operationId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operationId" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="operationId"> Operation ID. </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] Gets operation info.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperationAsync(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="operationId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="operationId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetOperationAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = await client.GetOperationAsync("b704bb00-d130-4f3f-a1d8-ca96de3eabb4", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("operationId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("resourceLocation").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetOperationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>> GetOperationAsync (string operationId, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>> GetOperationAsync(string operationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperationAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperationAsync (operationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DocumentIntelligenceOperationDetails))" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="abstract member GetOperationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>>
override this.GetOperationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>>" Usage="documentIntelligenceAdministrationClient.GetOperationAsync (operationId, cancellationToken)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.OperationDetails>> GetOperationAsync (string operationId, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.DocumentIntelligence.OperationDetails>> GetOperationAsync(string operationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperationAsync (operationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of OperationDetails))" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="abstract member GetOperationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.OperationDetails>>
override this.GetOperationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.OperationDetails>>" Usage="documentIntelligenceAdministrationClient.GetOperationAsync (operationId, cancellationToken)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType FrameworkAlternate="azure-dotnet">System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>></ReturnType>
<ReturnType FrameworkAlternate="azure-dotnet-preview">System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.OperationDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operationId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operationId"> Operation ID. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets operation info. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="operationId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="operationId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentIntelligenceOperationDetails> response = await client.GetOperationAsync("b704bb00-d130-4f3f-a1d8-ca96de3eabb4");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetOperations">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetOperations (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetOperations(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperations(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperations (context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetOperations : Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetOperations : Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="documentIntelligenceAdministrationClient.GetOperations context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></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] Lists all operations.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperations(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </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 GetOperations and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
foreach (BinaryData item in client.GetOperations(null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("operationId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("resourceLocation").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetOperations">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails> GetOperations (System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails> GetOperations(valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperations(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperations (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DocumentIntelligenceOperationDetails)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="abstract member GetOperations : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>
override this.GetOperations : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>" Usage="documentIntelligenceAdministrationClient.GetOperations cancellationToken" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.AI.DocumentIntelligence.OperationDetails> GetOperations (System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.AI.DocumentIntelligence.OperationDetails> GetOperations(valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperations (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of OperationDetails)" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="abstract member GetOperations : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.OperationDetails>
override this.GetOperations : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.OperationDetails>" Usage="documentIntelligenceAdministrationClient.GetOperations cancellationToken" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType FrameworkAlternate="azure-dotnet">Azure.Pageable<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails></ReturnType>
<ReturnType FrameworkAlternate="azure-dotnet-preview">Azure.Pageable<Azure.AI.DocumentIntelligence.OperationDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all operations. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetOperations.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
foreach (DocumentIntelligenceOperationDetails item in client.GetOperations())
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetOperationsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetOperationsAsync (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetOperationsAsync(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperationsAsync(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperationsAsync (context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetOperationsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetOperationsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="documentIntelligenceAdministrationClient.GetOperationsAsync context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></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] Lists all operations.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperationsAsync(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </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 GetOperationsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
await foreach (BinaryData item in client.GetOperationsAsync(null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("operationId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("kind").ToString());
Console.WriteLine(result.GetProperty("resourceLocation").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetOperationsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails> GetOperationsAsync (System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails> GetOperationsAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetOperationsAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperationsAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DocumentIntelligenceOperationDetails)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="abstract member GetOperationsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>
override this.GetOperationsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails>" Usage="documentIntelligenceAdministrationClient.GetOperationsAsync cancellationToken" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.AI.DocumentIntelligence.OperationDetails> GetOperationsAsync (System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.AI.DocumentIntelligence.OperationDetails> GetOperationsAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetOperationsAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of OperationDetails)" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="abstract member GetOperationsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.OperationDetails>
override this.GetOperationsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.OperationDetails>" Usage="documentIntelligenceAdministrationClient.GetOperationsAsync cancellationToken" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType FrameworkAlternate="azure-dotnet">Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentIntelligenceOperationDetails></ReturnType>
<ReturnType FrameworkAlternate="azure-dotnet-preview">Azure.AsyncPageable<Azure.AI.DocumentIntelligence.OperationDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all operations. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetOperationsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
await foreach (DocumentIntelligenceOperationDetails item in client.GetOperationsAsync())
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetResourceDetails">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetResourceDetails (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetResourceDetails(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceDetails(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetResourceDetails (context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetResourceDetails : Azure.RequestContext -> Azure.Response
override this.GetResourceDetails : Azure.RequestContext -> Azure.Response" Usage="documentIntelligenceAdministrationClient.GetResourceDetails context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Azure.RequestContext" Index="0" FrameworkAlternate="azure-dotnet" />
</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] Return information about the current resource.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceDetails(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 GetResourceDetails and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = client.GetResourceDetails(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("count").ToString());
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("limit").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetResourceDetails">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceResourceDetails> GetResourceDetails (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.DocumentIntelligenceResourceDetails> GetResourceDetails(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceDetails(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetResourceDetails (Optional cancellationToken As CancellationToken = Nothing) As Response(Of DocumentIntelligenceResourceDetails)" />
<MemberSignature Language="F#" Value="abstract member GetResourceDetails : System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceResourceDetails>
override this.GetResourceDetails : System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceResourceDetails>" Usage="documentIntelligenceAdministrationClient.GetResourceDetails cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceResourceDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Return information about the current resource. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetResourceDetails.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentIntelligenceResourceDetails> response = client.GetResourceDetails();
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetResourceDetailsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetResourceDetailsAsync (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetResourceDetailsAsync(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceDetailsAsync(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetResourceDetailsAsync (context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetResourceDetailsAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetResourceDetailsAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentIntelligenceAdministrationClient.GetResourceDetailsAsync context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</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" Index="0" FrameworkAlternate="azure-dotnet" />
</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] Return information about the current resource.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceDetailsAsync(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 GetResourceDetailsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = await client.GetResourceDetailsAsync(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("count").ToString());
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("limit").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetResourceDetailsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceResourceDetails>> GetResourceDetailsAsync (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.DocumentIntelligence.DocumentIntelligenceResourceDetails>> GetResourceDetailsAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceDetailsAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetResourceDetailsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DocumentIntelligenceResourceDetails))" />
<MemberSignature Language="F#" Value="abstract member GetResourceDetailsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceResourceDetails>>
override this.GetResourceDetailsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceResourceDetails>>" Usage="documentIntelligenceAdministrationClient.GetResourceDetailsAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.DocumentIntelligenceResourceDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Return information about the current resource. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetResourceDetailsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<DocumentIntelligenceResourceDetails> response = await client.GetResourceDetailsAsync();
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetResourceInfo">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetResourceInfo (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetResourceInfo(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceInfo(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetResourceInfo (context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetResourceInfo : Azure.RequestContext -> Azure.Response
override this.GetResourceInfo : Azure.RequestContext -> Azure.Response" Usage="documentIntelligenceAdministrationClient.GetResourceInfo context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Azure.RequestContext" Index="0" FrameworkAlternate="azure-dotnet-preview" />
</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] Return information about the current resource.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceInfo(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 GetResourceInfo and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = client.GetResourceInfo(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("count").ToString());
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("limit").ToString());
]]></code>
This sample shows how to call GetResourceInfo with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = client.GetResourceInfo(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("count").ToString());
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("limit").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetResourceInfo">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.DocumentIntelligence.ResourceDetails> GetResourceInfo (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.DocumentIntelligence.ResourceDetails> GetResourceInfo(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceInfo(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetResourceInfo (Optional cancellationToken As CancellationToken = Nothing) As Response(Of ResourceDetails)" />
<MemberSignature Language="F#" Value="abstract member GetResourceInfo : System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.ResourceDetails>
override this.GetResourceInfo : System.Threading.CancellationToken -> Azure.Response<Azure.AI.DocumentIntelligence.ResourceDetails>" Usage="documentIntelligenceAdministrationClient.GetResourceInfo cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.DocumentIntelligence.ResourceDetails></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Return information about the current resource. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetResourceInfo.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<ResourceDetails> response = client.GetResourceInfo();
]]></code>
This sample shows how to call GetResourceInfo with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<ResourceDetails> response = client.GetResourceInfo();
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetResourceInfoAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetResourceInfoAsync (Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetResourceInfoAsync(class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceInfoAsync(Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetResourceInfoAsync (context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetResourceInfoAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetResourceInfoAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentIntelligenceAdministrationClient.GetResourceInfoAsync context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</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" Index="0" FrameworkAlternate="azure-dotnet-preview" />
</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] Return information about the current resource.
<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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceInfoAsync(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 GetResourceInfoAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = await client.GetResourceInfoAsync(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("count").ToString());
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("limit").ToString());
]]></code>
This sample shows how to call GetResourceInfoAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response response = await client.GetResourceInfoAsync(null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("count").ToString());
Console.WriteLine(result.GetProperty("customDocumentModels").GetProperty("limit").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetResourceInfoAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ResourceDetails>> GetResourceInfoAsync (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.DocumentIntelligence.ResourceDetails>> GetResourceInfoAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.DocumentIntelligence.DocumentIntelligenceAdministrationClient.GetResourceInfoAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetResourceInfoAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ResourceDetails))" />
<MemberSignature Language="F#" Value="abstract member GetResourceInfoAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ResourceDetails>>
override this.GetResourceInfoAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ResourceDetails>>" Usage="documentIntelligenceAdministrationClient.GetResourceInfoAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.DocumentIntelligence.ResourceDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Return information about the current resource. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetResourceInfoAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<ResourceDetails> response = await client.GetResourceInfoAsync();
]]></code>
This sample shows how to call GetResourceInfoAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceAdministrationClient client = new DocumentIntelligenceAdministrationClient(endpoint, credential);
Response<ResourceDetails> response = await client.GetResourceInfoAsync();
]]></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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.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.DocumentIntelligence.DocumentIntelligenceAdministrationClient.Pipeline" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.DocumentIntelligence</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>
</Members>
</Type>