CI Update
Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=432443&view=results
This commit is contained in:
apexvss@microsoft.com
Родитель
11bb12f7ce
Коммит
b87516542d
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
|
@ -0,0 +1,257 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.TextTranslationClientBuilder"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder"
|
||||
name: "TextTranslationClientBuilder"
|
||||
nameWithType: "TextTranslationClientBuilder"
|
||||
summary: "A builder for creating a new instance of the Text<wbr>Translation<wbr>Client type."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TextTranslationClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.TextTranslationClientBuilder()"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.TextTranslationClientBuilder()"
|
||||
name: "TextTranslationClientBuilder()"
|
||||
nameWithType: "TextTranslationClientBuilder.TextTranslationClientBuilder()"
|
||||
summary: "Create an instance of the Text<wbr>Translation<wbr>Client<wbr>Builder."
|
||||
syntax: "public TextTranslationClientBuilder()"
|
||||
desc: "Create an instance of the TextTranslationClientBuilder."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
nameWithType: "TextTranslationClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "customPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.audience(com.azure.ai.translation.text.models.TextTranslationAudience)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.audience(TextTranslationAudience audience)"
|
||||
name: "audience(TextTranslationAudience audience)"
|
||||
nameWithType: "TextTranslationClientBuilder.audience(TextTranslationAudience audience)"
|
||||
summary: "Sets the Authentication audience used to authorize requests sent to the service."
|
||||
parameters:
|
||||
- description: "Token Audience."
|
||||
name: "audience"
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextTranslationAudience?alt=com.azure.ai.translation.text.models.TextTranslationAudience&text=TextTranslationAudience\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder audience(TextTranslationAudience audience)"
|
||||
desc: "Sets the Authentication audience used to authorize requests sent to the service."
|
||||
returns:
|
||||
description: "The updated <xref uid=\"com.azure.ai.translation.text.TextTranslationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TextTranslationClientBuilder\"></xref> object."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.buildAsyncClient()"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.buildAsyncClient()"
|
||||
name: "buildAsyncClient()"
|
||||
nameWithType: "TextTranslationClientBuilder.buildAsyncClient()"
|
||||
summary: "Builds an instance of Text<wbr>Translation<wbr>Async<wbr>Client class."
|
||||
syntax: "public TextTranslationAsyncClient buildAsyncClient()"
|
||||
desc: "Builds an instance of TextTranslationAsyncClient class."
|
||||
returns:
|
||||
description: "an instance of TextTranslationAsyncClient."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationAsyncClient?alt=com.azure.ai.translation.text.TextTranslationAsyncClient&text=TextTranslationAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.buildClient()"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.buildClient()"
|
||||
name: "buildClient()"
|
||||
nameWithType: "TextTranslationClientBuilder.buildClient()"
|
||||
summary: "Builds an instance of Text<wbr>Translation<wbr>Client class."
|
||||
syntax: "public TextTranslationClient buildClient()"
|
||||
desc: "Builds an instance of TextTranslationClient class."
|
||||
returns:
|
||||
description: "an instance of TextTranslationClient."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClient?alt=com.azure.ai.translation.text.TextTranslationClient&text=TextTranslationClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
name: "clientOptions(ClientOptions clientOptions)"
|
||||
nameWithType: "TextTranslationClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "clientOptions"
|
||||
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder clientOptions(ClientOptions clientOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.configuration(Configuration configuration)"
|
||||
name: "configuration(Configuration configuration)"
|
||||
nameWithType: "TextTranslationClientBuilder.configuration(Configuration configuration)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "configuration"
|
||||
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder configuration(Configuration configuration)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.credential(com.azure.core.credential.KeyCredential)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.credential(KeyCredential credential)"
|
||||
name: "credential(KeyCredential credential)"
|
||||
nameWithType: "TextTranslationClientBuilder.credential(KeyCredential credential)"
|
||||
summary: "Sets the <xref uid=\"com.azure.core.credential.KeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"KeyCredential\"></xref> used to authorize requests sent to the service."
|
||||
parameters:
|
||||
- description: "<xref uid=\"com.azure.core.credential.KeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"KeyCredential\"></xref> used to authorize requests sent to the service."
|
||||
name: "credential"
|
||||
type: "<xref href=\"com.azure.core.credential.KeyCredential?alt=com.azure.core.credential.KeyCredential&text=KeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder credential(KeyCredential credential)"
|
||||
desc: "Sets the <xref uid=\"com.azure.core.credential.KeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"KeyCredential\"></xref> used to authorize requests sent to the service."
|
||||
returns:
|
||||
description: "The updated <xref uid=\"com.azure.ai.translation.text.TextTranslationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TextTranslationClientBuilder\"></xref> object."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
name: "credential(TokenCredential tokenCredential)"
|
||||
nameWithType: "TextTranslationClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
summary: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
||||
parameters:
|
||||
- description: "<xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
||||
name: "tokenCredential"
|
||||
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder credential(TokenCredential tokenCredential)"
|
||||
desc: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service. Refer to the Azure SDK for Java [identity and authentication][] documentation for more details on proper usage of the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity"
|
||||
returns:
|
||||
description: "The updated <xref uid=\"com.azure.ai.translation.text.TextTranslationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TextTranslationClientBuilder\"></xref> object."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.endpoint(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.endpoint(String endpoint)"
|
||||
name: "endpoint(String endpoint)"
|
||||
nameWithType: "TextTranslationClientBuilder.endpoint(String endpoint)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "endpoint"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TextTranslationClientBuilder endpoint(String endpoint)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.httpClient(HttpClient httpClient)"
|
||||
name: "httpClient(HttpClient httpClient)"
|
||||
nameWithType: "TextTranslationClientBuilder.httpClient(HttpClient httpClient)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpClient"
|
||||
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder httpClient(HttpClient httpClient)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
nameWithType: "TextTranslationClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpLogOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
name: "pipeline(HttpPipeline pipeline)"
|
||||
nameWithType: "TextTranslationClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "pipeline"
|
||||
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder pipeline(HttpPipeline pipeline)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.region(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.region(String region)"
|
||||
name: "region(String region)"
|
||||
nameWithType: "TextTranslationClientBuilder.region(String region)"
|
||||
summary: "Sets the region used to authorize requests sent to the service."
|
||||
parameters:
|
||||
- description: "where the Translator resource is created."
|
||||
name: "region"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TextTranslationClientBuilder region(String region)"
|
||||
desc: "Sets the region used to authorize requests sent to the service."
|
||||
returns:
|
||||
description: "The updated <xref uid=\"com.azure.ai.translation.text.TextTranslationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TextTranslationClientBuilder\"></xref> object."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.resourceId(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.resourceId(String resourceId)"
|
||||
name: "resourceId(String resourceId)"
|
||||
nameWithType: "TextTranslationClientBuilder.resourceId(String resourceId)"
|
||||
summary: "Sets the Azure Resource Id used to authorize requests sent to the service."
|
||||
parameters:
|
||||
- description: "Id of the Translator Resource."
|
||||
name: "resourceId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TextTranslationClientBuilder resourceId(String resourceId)"
|
||||
desc: "Sets the Azure Resource Id used to authorize requests sent to the service."
|
||||
returns:
|
||||
description: "The updated <xref uid=\"com.azure.ai.translation.text.TextTranslationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TextTranslationClientBuilder\"></xref> object."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
name: "retryOptions(RetryOptions retryOptions)"
|
||||
nameWithType: "TextTranslationClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "retryOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder retryOptions(RetryOptions retryOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
name: "retryPolicy(RetryPolicy retryPolicy)"
|
||||
nameWithType: "TextTranslationClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
summary: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
parameters:
|
||||
- description: "the retryPolicy value."
|
||||
name: "retryPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryPolicy?alt=com.azure.core.http.policy.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
||||
desc: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
returns:
|
||||
description: "the TextTranslationClientBuilder."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationClientBuilder.serviceVersion(com.azure.ai.translation.text.TextTranslationServiceVersion)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationClientBuilder.serviceVersion(TextTranslationServiceVersion serviceVersion)"
|
||||
name: "serviceVersion(TextTranslationServiceVersion serviceVersion)"
|
||||
nameWithType: "TextTranslationClientBuilder.serviceVersion(TextTranslationServiceVersion serviceVersion)"
|
||||
summary: "Sets Service version."
|
||||
parameters:
|
||||
- description: "the serviceVersion value."
|
||||
name: "serviceVersion"
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationServiceVersion?alt=com.azure.ai.translation.text.TextTranslationServiceVersion&text=TextTranslationServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TextTranslationClientBuilder serviceVersion(TextTranslationServiceVersion serviceVersion)"
|
||||
desc: "Sets Service version."
|
||||
returns:
|
||||
description: "the TextTranslationClientBuilder."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A builder for creating a new instance of the TextTranslationClient type."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.TextTranslationClientBuilder?alt=com.azure.ai.translation.text.TextTranslationClientBuilder&text=TextTranslationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
### YamlMime:JavaEnum
|
||||
uid: "com.azure.ai.translation.text.TextTranslationServiceVersion"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationServiceVersion"
|
||||
name: "TextTranslationServiceVersion"
|
||||
nameWithType: "TextTranslationServiceVersion"
|
||||
summary: "Service version of Text<wbr>Translation<wbr>Client."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-\">valueOf</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-\">compareTo</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--\">getDeclaringClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--\">name</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--\">ordinal</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--\">toString</a>"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public enum **TextTranslationServiceVersion**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.ai.translation.text.TextTranslationServiceVersion?alt=com.azure.ai.translation.text.TextTranslationServiceVersion&text=TextTranslationServiceVersion\" data-throw-if-not-resolved=\"False\" />></br> implements <xref href=\"com.azure.core.util.ServiceVersion?alt=com.azure.core.util.ServiceVersion&text=ServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
fields:
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationServiceVersion.V3_0"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationServiceVersion.V3_0"
|
||||
name: "V3_0"
|
||||
nameWithType: "TextTranslationServiceVersion.V3_0"
|
||||
summary: "Enum value 3.0."
|
||||
desc: "Enum value 3.0."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationServiceVersion.getLatest()"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationServiceVersion.getLatest()"
|
||||
name: "getLatest()"
|
||||
nameWithType: "TextTranslationServiceVersion.getLatest()"
|
||||
summary: "Gets the latest service version supported by this client library."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static TextTranslationServiceVersion getLatest()"
|
||||
desc: "Gets the latest service version supported by this client library."
|
||||
returns:
|
||||
description: "The latest <xref uid=\"com.azure.ai.translation.text.TextTranslationServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TextTranslationServiceVersion\"></xref>."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationServiceVersion?alt=com.azure.ai.translation.text.TextTranslationServiceVersion&text=TextTranslationServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationServiceVersion.getVersion()"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationServiceVersion.getVersion()"
|
||||
name: "getVersion()"
|
||||
nameWithType: "TextTranslationServiceVersion.getVersion()"
|
||||
syntax: "public String getVersion()"
|
||||
returns:
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationServiceVersion.valueOf(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationServiceVersion.valueOf(String name)"
|
||||
name: "valueOf(String name)"
|
||||
nameWithType: "TextTranslationServiceVersion.valueOf(String name)"
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static TextTranslationServiceVersion valueOf(String name)"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationServiceVersion?alt=com.azure.ai.translation.text.TextTranslationServiceVersion&text=TextTranslationServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.TextTranslationServiceVersion.values()"
|
||||
fullName: "com.azure.ai.translation.text.TextTranslationServiceVersion.values()"
|
||||
name: "values()"
|
||||
nameWithType: "TextTranslationServiceVersion.values()"
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static TextTranslationServiceVersion[] values()"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.TextTranslationServiceVersion?alt=com.azure.ai.translation.text.TextTranslationServiceVersion&text=TextTranslationServiceVersion\" data-throw-if-not-resolved=\"False\" />[]"
|
||||
desc: "Service version of TextTranslationClient."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.util.ServiceVersion?alt=com.azure.core.util.ServiceVersion&text=ServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.BackTranslation"
|
||||
fullName: "com.azure.ai.translation.text.models.BackTranslation"
|
||||
name: "BackTranslation"
|
||||
nameWithType: "BackTranslation"
|
||||
summary: "Back Translation."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **BackTranslation**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.BackTranslation.getDisplayText()"
|
||||
fullName: "com.azure.ai.translation.text.models.BackTranslation.getDisplayText()"
|
||||
name: "getDisplayText()"
|
||||
nameWithType: "BackTranslation.getDisplayText()"
|
||||
summary: "Get the display<wbr>Text property: A string giving the source term that is a back-translation of the target in a form best suited for end-user display."
|
||||
syntax: "public String getDisplayText()"
|
||||
desc: "Get the displayText property: A string giving the source term that is a back-translation of the target in a form best suited for end-user display."
|
||||
returns:
|
||||
description: "the displayText value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.BackTranslation.getExamplesCount()"
|
||||
fullName: "com.azure.ai.translation.text.models.BackTranslation.getExamplesCount()"
|
||||
name: "getExamplesCount()"
|
||||
nameWithType: "BackTranslation.getExamplesCount()"
|
||||
summary: "Get the examples<wbr>Count property: An integer representing the number of examples that are available for this translation pair."
|
||||
syntax: "public int getExamplesCount()"
|
||||
desc: "Get the examplesCount property: An integer representing the number of examples that are available for this translation pair. Actual examples must be retrieved with a separate call to lookup examples. The number is mostly intended to facilitate display in a UX. For example, a user interface may add a hyperlink to the back-translation if the number of examples is greater than zero and show the back-translation as plain text if there are no examples. Note that the actual number of examples returned by a call to lookup examples may be less than numExamples, because additional filtering may be applied on the fly to remove \"bad\" examples."
|
||||
returns:
|
||||
description: "the examplesCount value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.BackTranslation.getFrequencyCount()"
|
||||
fullName: "com.azure.ai.translation.text.models.BackTranslation.getFrequencyCount()"
|
||||
name: "getFrequencyCount()"
|
||||
nameWithType: "BackTranslation.getFrequencyCount()"
|
||||
summary: "Get the frequency<wbr>Count property: An integer representing the frequency of this translation pair in the data."
|
||||
syntax: "public int getFrequencyCount()"
|
||||
desc: "Get the frequencyCount property: An integer representing the frequency of this translation pair in the data. The main purpose of this field is to provide a user interface with a means to sort back-translations so the most frequent terms are first."
|
||||
returns:
|
||||
description: "the frequencyCount value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.BackTranslation.getNormalizedText()"
|
||||
fullName: "com.azure.ai.translation.text.models.BackTranslation.getNormalizedText()"
|
||||
name: "getNormalizedText()"
|
||||
nameWithType: "BackTranslation.getNormalizedText()"
|
||||
summary: "Get the normalized<wbr>Text property: A string giving the normalized form of the source term that is a back-translation of the target."
|
||||
syntax: "public String getNormalizedText()"
|
||||
desc: "Get the normalizedText property: A string giving the normalized form of the source term that is a back-translation of the target. This value should be used as input to lookup examples."
|
||||
returns:
|
||||
description: "the normalizedText value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Back Translation."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.BreakSentenceItem"
|
||||
fullName: "com.azure.ai.translation.text.models.BreakSentenceItem"
|
||||
name: "BreakSentenceItem"
|
||||
nameWithType: "BreakSentenceItem"
|
||||
summary: "Item containing break sentence result."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **BreakSentenceItem**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.BreakSentenceItem.getDetectedLanguage()"
|
||||
fullName: "com.azure.ai.translation.text.models.BreakSentenceItem.getDetectedLanguage()"
|
||||
name: "getDetectedLanguage()"
|
||||
nameWithType: "BreakSentenceItem.getDetectedLanguage()"
|
||||
summary: "Get the detected<wbr>Language property: The detected<wbr>Language property is only present in the result object when language auto-detection is requested."
|
||||
syntax: "public DetectedLanguage getDetectedLanguage()"
|
||||
desc: "Get the detectedLanguage property: The detectedLanguage property is only present in the result object when language auto-detection is requested."
|
||||
returns:
|
||||
description: "the detectedLanguage value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.DetectedLanguage?alt=com.azure.ai.translation.text.models.DetectedLanguage&text=DetectedLanguage\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.BreakSentenceItem.getSentencesLengths()"
|
||||
fullName: "com.azure.ai.translation.text.models.BreakSentenceItem.getSentencesLengths()"
|
||||
name: "getSentencesLengths()"
|
||||
nameWithType: "BreakSentenceItem.getSentencesLengths()"
|
||||
summary: "Get the sentences<wbr>Lengths property: An integer array representing the lengths of the sentences in the input text."
|
||||
syntax: "public List<Integer> getSentencesLengths()"
|
||||
desc: "Get the sentencesLengths property: An integer array representing the lengths of the sentences in the input text. The length of the array is the number of sentences, and the values are the length of each sentence."
|
||||
returns:
|
||||
description: "the sentencesLengths value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>>"
|
||||
type: "class"
|
||||
desc: "Item containing break sentence result."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.DetectedLanguage"
|
||||
fullName: "com.azure.ai.translation.text.models.DetectedLanguage"
|
||||
name: "DetectedLanguage"
|
||||
nameWithType: "DetectedLanguage"
|
||||
summary: "An object describing the detected language."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DetectedLanguage**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.DetectedLanguage.getConfidence()"
|
||||
fullName: "com.azure.ai.translation.text.models.DetectedLanguage.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "DetectedLanguage.getConfidence()"
|
||||
summary: "Get the confidence property: A float value indicating the confidence in the result."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: A float value indicating the confidence in the result. The score is between zero and one and a low score indicates a low confidence."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.DetectedLanguage.getLanguage()"
|
||||
fullName: "com.azure.ai.translation.text.models.DetectedLanguage.getLanguage()"
|
||||
name: "getLanguage()"
|
||||
nameWithType: "DetectedLanguage.getLanguage()"
|
||||
summary: "Get the language property: A string representing the code of the detected language."
|
||||
syntax: "public String getLanguage()"
|
||||
desc: "Get the language property: A string representing the code of the detected language."
|
||||
returns:
|
||||
description: "the language value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "An object describing the detected language."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,89 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.DictionaryExample"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExample"
|
||||
name: "DictionaryExample"
|
||||
nameWithType: "DictionaryExample"
|
||||
summary: "Dictionary Example."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DictionaryExample**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExample.getSourcePrefix()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExample.getSourcePrefix()"
|
||||
name: "getSourcePrefix()"
|
||||
nameWithType: "DictionaryExample.getSourcePrefix()"
|
||||
summary: "Get the source<wbr>Prefix property: The string to concatenate before the value of source<wbr>Term to form a complete example."
|
||||
syntax: "public String getSourcePrefix()"
|
||||
desc: "Get the sourcePrefix property: The string to concatenate before the value of sourceTerm to form a complete example. Do not add a space character, since it is already there when it should be. This value may be an empty string."
|
||||
returns:
|
||||
description: "the sourcePrefix value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExample.getSourceSuffix()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExample.getSourceSuffix()"
|
||||
name: "getSourceSuffix()"
|
||||
nameWithType: "DictionaryExample.getSourceSuffix()"
|
||||
summary: "Get the source<wbr>Suffix property: The string to concatenate after the value of source<wbr>Term to form a complete example."
|
||||
syntax: "public String getSourceSuffix()"
|
||||
desc: "Get the sourceSuffix property: The string to concatenate after the value of sourceTerm to form a complete example. Do not add a space character, since it is already there when it should be. This value may be an empty string."
|
||||
returns:
|
||||
description: "the sourceSuffix value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExample.getSourceTerm()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExample.getSourceTerm()"
|
||||
name: "getSourceTerm()"
|
||||
nameWithType: "DictionaryExample.getSourceTerm()"
|
||||
summary: "Get the source<wbr>Term property: A string equal to the actual term looked up."
|
||||
syntax: "public String getSourceTerm()"
|
||||
desc: "Get the sourceTerm property: A string equal to the actual term looked up. The string is added with sourcePrefix and sourceSuffix to form the complete example. Its value is separated so it can be marked in a user interface, e.g., by bolding it."
|
||||
returns:
|
||||
description: "the sourceTerm value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExample.getTargetPrefix()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExample.getTargetPrefix()"
|
||||
name: "getTargetPrefix()"
|
||||
nameWithType: "DictionaryExample.getTargetPrefix()"
|
||||
summary: "Get the target<wbr>Prefix property: A string similar to source<wbr>Prefix but for the target."
|
||||
syntax: "public String getTargetPrefix()"
|
||||
desc: "Get the targetPrefix property: A string similar to sourcePrefix but for the target."
|
||||
returns:
|
||||
description: "the targetPrefix value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExample.getTargetSuffix()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExample.getTargetSuffix()"
|
||||
name: "getTargetSuffix()"
|
||||
nameWithType: "DictionaryExample.getTargetSuffix()"
|
||||
summary: "Get the target<wbr>Suffix property: A string similar to source<wbr>Suffix but for the target."
|
||||
syntax: "public String getTargetSuffix()"
|
||||
desc: "Get the targetSuffix property: A string similar to sourceSuffix but for the target."
|
||||
returns:
|
||||
description: "the targetSuffix value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExample.getTargetTerm()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExample.getTargetTerm()"
|
||||
name: "getTargetTerm()"
|
||||
nameWithType: "DictionaryExample.getTargetTerm()"
|
||||
summary: "Get the target<wbr>Term property: A string similar to source<wbr>Term but for the target."
|
||||
syntax: "public String getTargetTerm()"
|
||||
desc: "Get the targetTerm property: A string similar to sourceTerm but for the target."
|
||||
returns:
|
||||
description: "the targetTerm value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Dictionary Example."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.DictionaryExampleItem"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExampleItem"
|
||||
name: "DictionaryExampleItem"
|
||||
nameWithType: "DictionaryExampleItem"
|
||||
summary: "Dictionary Example element."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DictionaryExampleItem**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExampleItem.getExamples()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExampleItem.getExamples()"
|
||||
name: "getExamples()"
|
||||
nameWithType: "DictionaryExampleItem.getExamples()"
|
||||
summary: "Get the examples property: A list of examples for the (source term, target term) pair."
|
||||
syntax: "public List<DictionaryExample> getExamples()"
|
||||
desc: "Get the examples property: A list of examples for the (source term, target term) pair."
|
||||
returns:
|
||||
description: "the examples value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.translation.text.models.DictionaryExample?alt=com.azure.ai.translation.text.models.DictionaryExample&text=DictionaryExample\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExampleItem.getNormalizedSource()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExampleItem.getNormalizedSource()"
|
||||
name: "getNormalizedSource()"
|
||||
nameWithType: "DictionaryExampleItem.getNormalizedSource()"
|
||||
summary: "Get the normalized<wbr>Source property: A string giving the normalized form of the source term."
|
||||
syntax: "public String getNormalizedSource()"
|
||||
desc: "Get the normalizedSource property: A string giving the normalized form of the source term. Generally, this should be identical to the value of the Text field at the matching list index in the body of the request."
|
||||
returns:
|
||||
description: "the normalizedSource value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExampleItem.getNormalizedTarget()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExampleItem.getNormalizedTarget()"
|
||||
name: "getNormalizedTarget()"
|
||||
nameWithType: "DictionaryExampleItem.getNormalizedTarget()"
|
||||
summary: "Get the normalized<wbr>Target property: A string giving the normalized form of the target term."
|
||||
syntax: "public String getNormalizedTarget()"
|
||||
desc: "Get the normalizedTarget property: A string giving the normalized form of the target term. Generally, this should be identical to the value of the Translation field at the matching list index in the body of the request."
|
||||
returns:
|
||||
description: "the normalizedTarget value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Dictionary Example element."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.DictionaryExampleTextItem"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExampleTextItem"
|
||||
name: "DictionaryExampleTextItem"
|
||||
nameWithType: "DictionaryExampleTextItem"
|
||||
summary: "Element containing the text with translation."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.translation.text.models.InputTextItem?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.ai.translation.text.models.InputTextItem?alt=com.azure.ai.translation.text.models.InputTextItem&text=InputTextItem\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.ai.translation.text.models.InputTextItem.getText()?alt=com.azure.ai.translation.text.models.InputTextItem.getText&text=getText\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DictionaryExampleTextItem**</br> extends <xref href=\"com.azure.ai.translation.text.models.InputTextItem?alt=com.azure.ai.translation.text.models.InputTextItem&text=InputTextItem\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExampleTextItem.DictionaryExampleTextItem(java.lang.String,java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExampleTextItem.DictionaryExampleTextItem(String text, String translation)"
|
||||
name: "DictionaryExampleTextItem(String text, String translation)"
|
||||
nameWithType: "DictionaryExampleTextItem.DictionaryExampleTextItem(String text, String translation)"
|
||||
summary: "Creates an instance of Dictionary<wbr>Example<wbr>Text<wbr>Item class."
|
||||
parameters:
|
||||
- description: "the text value to set."
|
||||
name: "text"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the translation value to set."
|
||||
name: "translation"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public DictionaryExampleTextItem(String text, String translation)"
|
||||
desc: "Creates an instance of DictionaryExampleTextItem class."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryExampleTextItem.getTranslation()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryExampleTextItem.getTranslation()"
|
||||
name: "getTranslation()"
|
||||
nameWithType: "DictionaryExampleTextItem.getTranslation()"
|
||||
summary: "Get the translation property: A string specifying the translated text previously returned by the Dictionary lookup operation."
|
||||
syntax: "public String getTranslation()"
|
||||
desc: "Get the translation property: A string specifying the translated text previously returned by the Dictionary lookup operation. This should be the value from the normalizedTarget field in the translations list of the Dictionary lookup response. The service will return examples for the specific source-target word-pair."
|
||||
returns:
|
||||
description: "the translation value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Element containing the text with translation."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.DictionaryLookupItem"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryLookupItem"
|
||||
name: "DictionaryLookupItem"
|
||||
nameWithType: "DictionaryLookupItem"
|
||||
summary: "Dictionary Lookup Element."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DictionaryLookupItem**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryLookupItem.getDisplaySource()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryLookupItem.getDisplaySource()"
|
||||
name: "getDisplaySource()"
|
||||
nameWithType: "DictionaryLookupItem.getDisplaySource()"
|
||||
summary: "Get the display<wbr>Source property: A string giving the source term in a form best suited for end-user display."
|
||||
syntax: "public String getDisplaySource()"
|
||||
desc: "Get the displaySource property: A string giving the source term in a form best suited for end-user display. For example, if the input is \"JOHN\", the display form will reflect the usual spelling of the name: \"John\"."
|
||||
returns:
|
||||
description: "the displaySource value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryLookupItem.getNormalizedSource()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryLookupItem.getNormalizedSource()"
|
||||
name: "getNormalizedSource()"
|
||||
nameWithType: "DictionaryLookupItem.getNormalizedSource()"
|
||||
summary: "Get the normalized<wbr>Source property: A string giving the normalized form of the source term."
|
||||
syntax: "public String getNormalizedSource()"
|
||||
desc: "Get the normalizedSource property: A string giving the normalized form of the source term. For example, if the request is \"JOHN\", the normalized form will be \"john\". The content of this field becomes the input to lookup examples."
|
||||
returns:
|
||||
description: "the normalizedSource value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryLookupItem.getTranslations()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryLookupItem.getTranslations()"
|
||||
name: "getTranslations()"
|
||||
nameWithType: "DictionaryLookupItem.getTranslations()"
|
||||
summary: "Get the translations property: A list of translations for the source term."
|
||||
syntax: "public List<DictionaryTranslation> getTranslations()"
|
||||
desc: "Get the translations property: A list of translations for the source term."
|
||||
returns:
|
||||
description: "the translations value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.translation.text.models.DictionaryTranslation?alt=com.azure.ai.translation.text.models.DictionaryTranslation&text=DictionaryTranslation\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Dictionary Lookup Element."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,89 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.DictionaryTranslation"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryTranslation"
|
||||
name: "DictionaryTranslation"
|
||||
nameWithType: "DictionaryTranslation"
|
||||
summary: "Translation source term."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DictionaryTranslation**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryTranslation.getBackTranslations()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryTranslation.getBackTranslations()"
|
||||
name: "getBackTranslations()"
|
||||
nameWithType: "DictionaryTranslation.getBackTranslations()"
|
||||
summary: "Get the back<wbr>Translations property: A list of \"back translations\" of the target."
|
||||
syntax: "public List<BackTranslation> getBackTranslations()"
|
||||
desc: "Get the backTranslations property: A list of \"back translations\" of the target. For example, source words that the target can translate to. The list is guaranteed to contain the source word that was requested (e.g., if the source word being looked up is \"fly\", then it is guaranteed that \"fly\" will be in the backTranslations list). However, it is not guaranteed to be in the first position, and often will not be."
|
||||
returns:
|
||||
description: "the backTranslations value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.translation.text.models.BackTranslation?alt=com.azure.ai.translation.text.models.BackTranslation&text=BackTranslation\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryTranslation.getConfidence()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryTranslation.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "DictionaryTranslation.getConfidence()"
|
||||
summary: "Get the confidence property: A value between 0.0 and 1.0 which represents the \"confidence\" (or perhaps more accurately, \"probability in the training data\") of that translation pair."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: A value between 0.0 and 1.0 which represents the \"confidence\" (or perhaps more accurately, \"probability in the training data\") of that translation pair. The sum of confidence scores for one source word may or may not sum to 1.0."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryTranslation.getDisplayTarget()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryTranslation.getDisplayTarget()"
|
||||
name: "getDisplayTarget()"
|
||||
nameWithType: "DictionaryTranslation.getDisplayTarget()"
|
||||
summary: "Get the display<wbr>Target property: A string giving the term in the target language and in a form best suited for end-user display."
|
||||
syntax: "public String getDisplayTarget()"
|
||||
desc: "Get the displayTarget property: A string giving the term in the target language and in a form best suited for end-user display. Generally, this will only differ from the normalizedTarget in terms of capitalization. For example, a proper noun like \"Juan\" will have normalizedTarget = \"juan\" and displayTarget = \"Juan\"."
|
||||
returns:
|
||||
description: "the displayTarget value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryTranslation.getNormalizedTarget()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryTranslation.getNormalizedTarget()"
|
||||
name: "getNormalizedTarget()"
|
||||
nameWithType: "DictionaryTranslation.getNormalizedTarget()"
|
||||
summary: "Get the normalized<wbr>Target property: A string giving the normalized form of this term in the target language."
|
||||
syntax: "public String getNormalizedTarget()"
|
||||
desc: "Get the normalizedTarget property: A string giving the normalized form of this term in the target language. This value should be used as input to lookup examples."
|
||||
returns:
|
||||
description: "the normalizedTarget value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryTranslation.getPosTag()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryTranslation.getPosTag()"
|
||||
name: "getPosTag()"
|
||||
nameWithType: "DictionaryTranslation.getPosTag()"
|
||||
summary: "Get the pos<wbr>Tag property: A string associating this term with a part-of-speech tag."
|
||||
syntax: "public String getPosTag()"
|
||||
desc: "Get the posTag property: A string associating this term with a part-of-speech tag."
|
||||
returns:
|
||||
description: "the posTag value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.DictionaryTranslation.getPrefixWord()"
|
||||
fullName: "com.azure.ai.translation.text.models.DictionaryTranslation.getPrefixWord()"
|
||||
name: "getPrefixWord()"
|
||||
nameWithType: "DictionaryTranslation.getPrefixWord()"
|
||||
summary: "Get the prefix<wbr>Word property: A string giving the word to display as a prefix of the translation."
|
||||
syntax: "public String getPrefixWord()"
|
||||
desc: "Get the prefixWord property: A string giving the word to display as a prefix of the translation. Currently, this is the gendered determiner of nouns, in languages that have gendered determiners. For example, the prefix of the Spanish word \"mosca\" is \"la\", since \"mosca\" is a feminine noun in Spanish. This is only dependent on the translation, and not on the source. If there is no prefix, it will be the empty string."
|
||||
returns:
|
||||
description: "the prefixWord value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Translation source term."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.GetSupportedLanguagesResult"
|
||||
fullName: "com.azure.ai.translation.text.models.GetSupportedLanguagesResult"
|
||||
name: "GetSupportedLanguagesResult"
|
||||
nameWithType: "GetSupportedLanguagesResult"
|
||||
summary: "Response for the languages API."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **GetSupportedLanguagesResult**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.GetSupportedLanguagesResult.getDictionary()"
|
||||
fullName: "com.azure.ai.translation.text.models.GetSupportedLanguagesResult.getDictionary()"
|
||||
name: "getDictionary()"
|
||||
nameWithType: "GetSupportedLanguagesResult.getDictionary()"
|
||||
summary: "Get the dictionary property: Languages that support dictionary API."
|
||||
syntax: "public Map<String,SourceDictionaryLanguage> getDictionary()"
|
||||
desc: "Get the dictionary property: Languages that support dictionary API."
|
||||
returns:
|
||||
description: "the dictionary value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.ai.translation.text.models.SourceDictionaryLanguage?alt=com.azure.ai.translation.text.models.SourceDictionaryLanguage&text=SourceDictionaryLanguage\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.translation.text.models.GetSupportedLanguagesResult.getTranslation()"
|
||||
fullName: "com.azure.ai.translation.text.models.GetSupportedLanguagesResult.getTranslation()"
|
||||
name: "getTranslation()"
|
||||
nameWithType: "GetSupportedLanguagesResult.getTranslation()"
|
||||
summary: "Get the translation property: Languages that support translate API."
|
||||
syntax: "public Map<String,TranslationLanguage> getTranslation()"
|
||||
desc: "Get the translation property: Languages that support translate API."
|
||||
returns:
|
||||
description: "the translation value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.ai.translation.text.models.TranslationLanguage?alt=com.azure.ai.translation.text.models.TranslationLanguage&text=TranslationLanguage\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.translation.text.models.GetSupportedLanguagesResult.getTransliteration()"
|
||||
fullName: "com.azure.ai.translation.text.models.GetSupportedLanguagesResult.getTransliteration()"
|
||||
name: "getTransliteration()"
|
||||
nameWithType: "GetSupportedLanguagesResult.getTransliteration()"
|
||||
summary: "Get the transliteration property: Languages that support transliteration API."
|
||||
syntax: "public Map<String,TransliterationLanguage> getTransliteration()"
|
||||
desc: "Get the transliteration property: Languages that support transliteration API."
|
||||
returns:
|
||||
description: "the transliteration value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.ai.translation.text.models.TransliterationLanguage?alt=com.azure.ai.translation.text.models.TransliterationLanguage&text=TransliterationLanguage\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Response for the languages API."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.InputTextItem"
|
||||
fullName: "com.azure.ai.translation.text.models.InputTextItem"
|
||||
name: "InputTextItem"
|
||||
nameWithType: "InputTextItem"
|
||||
summary: "Element containing the text for translation."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public class **InputTextItem**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.translation.text.models.InputTextItem.InputTextItem(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.InputTextItem.InputTextItem(String text)"
|
||||
name: "InputTextItem(String text)"
|
||||
nameWithType: "InputTextItem.InputTextItem(String text)"
|
||||
summary: "Creates an instance of Input<wbr>Text<wbr>Item class."
|
||||
parameters:
|
||||
- description: "the text value to set."
|
||||
name: "text"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public InputTextItem(String text)"
|
||||
desc: "Creates an instance of InputTextItem class."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.InputTextItem.getText()"
|
||||
fullName: "com.azure.ai.translation.text.models.InputTextItem.getText()"
|
||||
name: "getText()"
|
||||
nameWithType: "InputTextItem.getText()"
|
||||
summary: "Get the text property: Text to translate."
|
||||
syntax: "public String getText()"
|
||||
desc: "Get the text property: Text to translate."
|
||||
returns:
|
||||
description: "the text value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Element containing the text for translation."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
### YamlMime:JavaEnum
|
||||
uid: "com.azure.ai.translation.text.models.LanguageDirectionality"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageDirectionality"
|
||||
name: "LanguageDirectionality"
|
||||
nameWithType: "LanguageDirectionality"
|
||||
summary: "Language Directionality."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-\">valueOf</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-\">compareTo</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--\">getDeclaringClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--\">name</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--\">ordinal</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--\">toString</a>"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public enum **LanguageDirectionality**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.ai.translation.text.models.LanguageDirectionality?alt=com.azure.ai.translation.text.models.LanguageDirectionality&text=LanguageDirectionality\" data-throw-if-not-resolved=\"False\" />>"
|
||||
fields:
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageDirectionality.LEFT_TO_RIGHT"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageDirectionality.LEFT_TO_RIGHT"
|
||||
name: "LEFT_TO_RIGHT"
|
||||
nameWithType: "LanguageDirectionality.LEFT_TO_RIGHT"
|
||||
summary: "Language is written left to right."
|
||||
desc: "Language is written left to right."
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageDirectionality.RIGHT_TO_LEFT"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageDirectionality.RIGHT_TO_LEFT"
|
||||
name: "RIGHT_TO_LEFT"
|
||||
nameWithType: "LanguageDirectionality.RIGHT_TO_LEFT"
|
||||
summary: "Language is written right to left."
|
||||
desc: "Language is written right to left."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageDirectionality.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageDirectionality.fromString(String value)"
|
||||
name: "fromString(String value)"
|
||||
nameWithType: "LanguageDirectionality.fromString(String value)"
|
||||
summary: "Parses a serialized value to a Language<wbr>Directionality instance."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "the serialized value to parse."
|
||||
name: "value"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static LanguageDirectionality fromString(String value)"
|
||||
desc: "Parses a serialized value to a LanguageDirectionality instance."
|
||||
returns:
|
||||
description: "the parsed LanguageDirectionality object, or null if unable to parse."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageDirectionality?alt=com.azure.ai.translation.text.models.LanguageDirectionality&text=LanguageDirectionality\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageDirectionality.toString()"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageDirectionality.toString()"
|
||||
name: "toString()"
|
||||
nameWithType: "LanguageDirectionality.toString()"
|
||||
overridden: "java.lang.Enum.toString()"
|
||||
syntax: "public String toString()"
|
||||
returns:
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageDirectionality.valueOf(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageDirectionality.valueOf(String name)"
|
||||
name: "valueOf(String name)"
|
||||
nameWithType: "LanguageDirectionality.valueOf(String name)"
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static LanguageDirectionality valueOf(String name)"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageDirectionality?alt=com.azure.ai.translation.text.models.LanguageDirectionality&text=LanguageDirectionality\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageDirectionality.values()"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageDirectionality.values()"
|
||||
name: "values()"
|
||||
nameWithType: "LanguageDirectionality.values()"
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static LanguageDirectionality[] values()"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageDirectionality?alt=com.azure.ai.translation.text.models.LanguageDirectionality&text=LanguageDirectionality\" data-throw-if-not-resolved=\"False\" />[]"
|
||||
desc: "Language Directionality."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.LanguageScope"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScope"
|
||||
name: "LanguageScope"
|
||||
nameWithType: "LanguageScope"
|
||||
summary: "Translator languages scopes."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LanguageScope**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.models.LanguageScope?alt=com.azure.ai.translation.text.models.LanguageScope&text=LanguageScope\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScope.LanguageScope()"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScope.LanguageScope()"
|
||||
name: "LanguageScope()"
|
||||
nameWithType: "LanguageScope.LanguageScope()"
|
||||
summary: "Creates a new instance of Language<wbr>Scope value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.translation.text.models.LanguageScope.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public LanguageScope()"
|
||||
desc: "Creates a new instance of LanguageScope value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScope.DICTIONARY"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScope.DICTIONARY"
|
||||
name: "DICTIONARY"
|
||||
nameWithType: "LanguageScope.DICTIONARY"
|
||||
summary: "Static value Dictionary for Language<wbr>Scope."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageScope?alt=com.azure.ai.translation.text.models.LanguageScope&text=LanguageScope\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LanguageScope DICTIONARY"
|
||||
desc: "Static value Dictionary for LanguageScope."
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScope.TRANSLATION"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScope.TRANSLATION"
|
||||
name: "TRANSLATION"
|
||||
nameWithType: "LanguageScope.TRANSLATION"
|
||||
summary: "Static value Translation for Language<wbr>Scope."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageScope?alt=com.azure.ai.translation.text.models.LanguageScope&text=LanguageScope\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LanguageScope TRANSLATION"
|
||||
desc: "Static value Translation for LanguageScope."
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScope.TRANSLITERATION"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScope.TRANSLITERATION"
|
||||
name: "TRANSLITERATION"
|
||||
nameWithType: "LanguageScope.TRANSLITERATION"
|
||||
summary: "Static value Transliteration for Language<wbr>Scope."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageScope?alt=com.azure.ai.translation.text.models.LanguageScope&text=LanguageScope\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LanguageScope TRANSLITERATION"
|
||||
desc: "Static value Transliteration for LanguageScope."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScope.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScope.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "LanguageScope.fromString(String name)"
|
||||
summary: "Creates or finds a Language<wbr>Scope from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static LanguageScope fromString(String name)"
|
||||
desc: "Creates or finds a LanguageScope from its string representation."
|
||||
returns:
|
||||
description: "the corresponding LanguageScope."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageScope?alt=com.azure.ai.translation.text.models.LanguageScope&text=LanguageScope\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScope.values()"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScope.values()"
|
||||
name: "values()"
|
||||
nameWithType: "LanguageScope.values()"
|
||||
summary: "Gets known Language<wbr>Scope values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<LanguageScope> values()"
|
||||
desc: "Gets known LanguageScope values."
|
||||
returns:
|
||||
description: "known LanguageScope values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.translation.text.models.LanguageScope?alt=com.azure.ai.translation.text.models.LanguageScope&text=LanguageScope\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Translator languages scopes."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.LanguageScript"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScript"
|
||||
name: "LanguageScript"
|
||||
nameWithType: "LanguageScript"
|
||||
summary: "Common properties of language script."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public class **LanguageScript**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScript.LanguageScript(java.lang.String,java.lang.String,java.lang.String,com.azure.ai.translation.text.models.LanguageDirectionality)"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScript.LanguageScript(String code, String name, String nativeName, LanguageDirectionality directionality)"
|
||||
name: "LanguageScript(String code, String name, String nativeName, LanguageDirectionality directionality)"
|
||||
nameWithType: "LanguageScript.LanguageScript(String code, String name, String nativeName, LanguageDirectionality directionality)"
|
||||
summary: "Creates an instance of Language<wbr>Script class."
|
||||
modifiers:
|
||||
- "protected"
|
||||
parameters:
|
||||
- description: "the code value to set."
|
||||
name: "code"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the name value to set."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the nativeName value to set."
|
||||
name: "nativeName"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the directionality value to set."
|
||||
name: "directionality"
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageDirectionality?alt=com.azure.ai.translation.text.models.LanguageDirectionality&text=LanguageDirectionality\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "protected LanguageScript(String code, String name, String nativeName, LanguageDirectionality directionality)"
|
||||
desc: "Creates an instance of LanguageScript class."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScript.getCode()"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScript.getCode()"
|
||||
name: "getCode()"
|
||||
nameWithType: "LanguageScript.getCode()"
|
||||
summary: "Get the code property: Code identifying the script."
|
||||
syntax: "public String getCode()"
|
||||
desc: "Get the code property: Code identifying the script."
|
||||
returns:
|
||||
description: "the code value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScript.getDirectionality()"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScript.getDirectionality()"
|
||||
name: "getDirectionality()"
|
||||
nameWithType: "LanguageScript.getDirectionality()"
|
||||
summary: "Get the directionality property: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages."
|
||||
syntax: "public LanguageDirectionality getDirectionality()"
|
||||
desc: "Get the directionality property: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages."
|
||||
returns:
|
||||
description: "the directionality value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageDirectionality?alt=com.azure.ai.translation.text.models.LanguageDirectionality&text=LanguageDirectionality\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScript.getName()"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScript.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "LanguageScript.getName()"
|
||||
summary: "Get the name property: Display name of the script in the locale requested via Accept-Language header."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: Display name of the script in the locale requested via Accept-Language header."
|
||||
returns:
|
||||
description: "the name value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.LanguageScript.getNativeName()"
|
||||
fullName: "com.azure.ai.translation.text.models.LanguageScript.getNativeName()"
|
||||
name: "getNativeName()"
|
||||
nameWithType: "LanguageScript.getNativeName()"
|
||||
summary: "Get the native<wbr>Name property: Display name of the language in the locale native for the language."
|
||||
syntax: "public String getNativeName()"
|
||||
desc: "Get the nativeName property: Display name of the language in the locale native for the language."
|
||||
returns:
|
||||
description: "the nativeName value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Common properties of language script."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,100 @@
|
|||
### YamlMime:JavaEnum
|
||||
uid: "com.azure.ai.translation.text.models.ProfanityAction"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityAction"
|
||||
name: "ProfanityAction"
|
||||
nameWithType: "ProfanityAction"
|
||||
summary: "Translator profanity actions."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-\">valueOf</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-\">compareTo</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--\">getDeclaringClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--\">name</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--\">ordinal</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--\">toString</a>"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public enum **ProfanityAction**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.ai.translation.text.models.ProfanityAction?alt=com.azure.ai.translation.text.models.ProfanityAction&text=ProfanityAction\" data-throw-if-not-resolved=\"False\" />>"
|
||||
fields:
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityAction.DELETED"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityAction.DELETED"
|
||||
name: "DELETED"
|
||||
nameWithType: "ProfanityAction.DELETED"
|
||||
summary: "Profanity is deleted from the translated text."
|
||||
desc: "Profanity is deleted from the translated text."
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityAction.MARKED"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityAction.MARKED"
|
||||
name: "MARKED"
|
||||
nameWithType: "ProfanityAction.MARKED"
|
||||
summary: "Profanity is marked."
|
||||
desc: "Profanity is marked."
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityAction.NO_ACTION"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityAction.NO_ACTION"
|
||||
name: "NO_ACTION"
|
||||
nameWithType: "ProfanityAction.NO_ACTION"
|
||||
summary: "No Action is taken on profanity."
|
||||
desc: "No Action is taken on profanity."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityAction.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityAction.fromString(String value)"
|
||||
name: "fromString(String value)"
|
||||
nameWithType: "ProfanityAction.fromString(String value)"
|
||||
summary: "Parses a serialized value to a Profanity<wbr>Action instance."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "the serialized value to parse."
|
||||
name: "value"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static ProfanityAction fromString(String value)"
|
||||
desc: "Parses a serialized value to a ProfanityAction instance."
|
||||
returns:
|
||||
description: "the parsed ProfanityAction object, or null if unable to parse."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityAction?alt=com.azure.ai.translation.text.models.ProfanityAction&text=ProfanityAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityAction.toString()"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityAction.toString()"
|
||||
name: "toString()"
|
||||
nameWithType: "ProfanityAction.toString()"
|
||||
overridden: "java.lang.Enum.toString()"
|
||||
syntax: "public String toString()"
|
||||
returns:
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityAction.valueOf(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityAction.valueOf(String name)"
|
||||
name: "valueOf(String name)"
|
||||
nameWithType: "ProfanityAction.valueOf(String name)"
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static ProfanityAction valueOf(String name)"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityAction?alt=com.azure.ai.translation.text.models.ProfanityAction&text=ProfanityAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityAction.values()"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityAction.values()"
|
||||
name: "values()"
|
||||
nameWithType: "ProfanityAction.values()"
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static ProfanityAction[] values()"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityAction?alt=com.azure.ai.translation.text.models.ProfanityAction&text=ProfanityAction\" data-throw-if-not-resolved=\"False\" />[]"
|
||||
desc: "Translator profanity actions."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
### YamlMime:JavaEnum
|
||||
uid: "com.azure.ai.translation.text.models.ProfanityMarker"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityMarker"
|
||||
name: "ProfanityMarker"
|
||||
nameWithType: "ProfanityMarker"
|
||||
summary: "Translator profanity markers."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-\">valueOf</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-\">compareTo</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--\">getDeclaringClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--\">name</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--\">ordinal</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--\">toString</a>"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public enum **ProfanityMarker**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.ai.translation.text.models.ProfanityMarker?alt=com.azure.ai.translation.text.models.ProfanityMarker&text=ProfanityMarker\" data-throw-if-not-resolved=\"False\" />>"
|
||||
fields:
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityMarker.ASTERISK"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityMarker.ASTERISK"
|
||||
name: "ASTERISK"
|
||||
nameWithType: "ProfanityMarker.ASTERISK"
|
||||
summary: "Profanity is marked with asterisk."
|
||||
desc: "Profanity is marked with asterisk."
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityMarker.TAG"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityMarker.TAG"
|
||||
name: "TAG"
|
||||
nameWithType: "ProfanityMarker.TAG"
|
||||
summary: "Profanity is marked with the tags."
|
||||
desc: "Profanity is marked with the tags."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityMarker.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityMarker.fromString(String value)"
|
||||
name: "fromString(String value)"
|
||||
nameWithType: "ProfanityMarker.fromString(String value)"
|
||||
summary: "Parses a serialized value to a Profanity<wbr>Marker instance."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "the serialized value to parse."
|
||||
name: "value"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static ProfanityMarker fromString(String value)"
|
||||
desc: "Parses a serialized value to a ProfanityMarker instance."
|
||||
returns:
|
||||
description: "the parsed ProfanityMarker object, or null if unable to parse."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityMarker?alt=com.azure.ai.translation.text.models.ProfanityMarker&text=ProfanityMarker\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityMarker.toString()"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityMarker.toString()"
|
||||
name: "toString()"
|
||||
nameWithType: "ProfanityMarker.toString()"
|
||||
overridden: "java.lang.Enum.toString()"
|
||||
syntax: "public String toString()"
|
||||
returns:
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityMarker.valueOf(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityMarker.valueOf(String name)"
|
||||
name: "valueOf(String name)"
|
||||
nameWithType: "ProfanityMarker.valueOf(String name)"
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static ProfanityMarker valueOf(String name)"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityMarker?alt=com.azure.ai.translation.text.models.ProfanityMarker&text=ProfanityMarker\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.ProfanityMarker.values()"
|
||||
fullName: "com.azure.ai.translation.text.models.ProfanityMarker.values()"
|
||||
name: "values()"
|
||||
nameWithType: "ProfanityMarker.values()"
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static ProfanityMarker[] values()"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityMarker?alt=com.azure.ai.translation.text.models.ProfanityMarker&text=ProfanityMarker\" data-throw-if-not-resolved=\"False\" />[]"
|
||||
desc: "Translator profanity markers."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.SentenceBoundaries"
|
||||
fullName: "com.azure.ai.translation.text.models.SentenceBoundaries"
|
||||
name: "SentenceBoundaries"
|
||||
nameWithType: "SentenceBoundaries"
|
||||
summary: "An object returning sentence boundaries in the input and output texts."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **SentenceBoundaries**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.SentenceBoundaries.getSourceSentencesLengths()"
|
||||
fullName: "com.azure.ai.translation.text.models.SentenceBoundaries.getSourceSentencesLengths()"
|
||||
name: "getSourceSentencesLengths()"
|
||||
nameWithType: "SentenceBoundaries.getSourceSentencesLengths()"
|
||||
summary: "Get the source<wbr>Sentences<wbr>Lengths property: An integer array representing the lengths of the sentences in the input text."
|
||||
syntax: "public List<Integer> getSourceSentencesLengths()"
|
||||
desc: "Get the sourceSentencesLengths property: An integer array representing the lengths of the sentences in the input text. The length of the array is the number of sentences, and the values are the length of each sentence."
|
||||
returns:
|
||||
description: "the sourceSentencesLengths value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>>"
|
||||
- uid: "com.azure.ai.translation.text.models.SentenceBoundaries.getTranslatedSentencesLengths()"
|
||||
fullName: "com.azure.ai.translation.text.models.SentenceBoundaries.getTranslatedSentencesLengths()"
|
||||
name: "getTranslatedSentencesLengths()"
|
||||
nameWithType: "SentenceBoundaries.getTranslatedSentencesLengths()"
|
||||
summary: "Get the translated<wbr>Sentences<wbr>Lengths property: An integer array representing the lengths of the sentences in the translated text."
|
||||
syntax: "public List<Integer> getTranslatedSentencesLengths()"
|
||||
desc: "Get the translatedSentencesLengths property: An integer array representing the lengths of the sentences in the translated text. The length of the array is the number of sentences, and the values are the length of each sentence."
|
||||
returns:
|
||||
description: "the translatedSentencesLengths value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>>"
|
||||
type: "class"
|
||||
desc: "An object returning sentence boundaries in the input and output texts."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.SourceDictionaryLanguage"
|
||||
fullName: "com.azure.ai.translation.text.models.SourceDictionaryLanguage"
|
||||
name: "SourceDictionaryLanguage"
|
||||
nameWithType: "SourceDictionaryLanguage"
|
||||
summary: "Properties ot the source dictionary language."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **SourceDictionaryLanguage**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.SourceDictionaryLanguage.getDirectionality()"
|
||||
fullName: "com.azure.ai.translation.text.models.SourceDictionaryLanguage.getDirectionality()"
|
||||
name: "getDirectionality()"
|
||||
nameWithType: "SourceDictionaryLanguage.getDirectionality()"
|
||||
summary: "Get the directionality property: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages."
|
||||
syntax: "public LanguageDirectionality getDirectionality()"
|
||||
desc: "Get the directionality property: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages."
|
||||
returns:
|
||||
description: "the directionality value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageDirectionality?alt=com.azure.ai.translation.text.models.LanguageDirectionality&text=LanguageDirectionality\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.SourceDictionaryLanguage.getName()"
|
||||
fullName: "com.azure.ai.translation.text.models.SourceDictionaryLanguage.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "SourceDictionaryLanguage.getName()"
|
||||
summary: "Get the name property: Display name of the language in the locale requested via Accept-Language header."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: Display name of the language in the locale requested via Accept-Language header."
|
||||
returns:
|
||||
description: "the name value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.SourceDictionaryLanguage.getNativeName()"
|
||||
fullName: "com.azure.ai.translation.text.models.SourceDictionaryLanguage.getNativeName()"
|
||||
name: "getNativeName()"
|
||||
nameWithType: "SourceDictionaryLanguage.getNativeName()"
|
||||
summary: "Get the native<wbr>Name property: Display name of the language in the locale native for this language."
|
||||
syntax: "public String getNativeName()"
|
||||
desc: "Get the nativeName property: Display name of the language in the locale native for this language."
|
||||
returns:
|
||||
description: "the nativeName value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.SourceDictionaryLanguage.getTranslations()"
|
||||
fullName: "com.azure.ai.translation.text.models.SourceDictionaryLanguage.getTranslations()"
|
||||
name: "getTranslations()"
|
||||
nameWithType: "SourceDictionaryLanguage.getTranslations()"
|
||||
summary: "Get the translations property: List of languages with alterative translations and examples for the query expressed in the source language."
|
||||
syntax: "public List<TargetDictionaryLanguage> getTranslations()"
|
||||
desc: "Get the translations property: List of languages with alterative translations and examples for the query expressed in the source language."
|
||||
returns:
|
||||
description: "the translations value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.translation.text.models.TargetDictionaryLanguage?alt=com.azure.ai.translation.text.models.TargetDictionaryLanguage&text=TargetDictionaryLanguage\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Properties ot the source dictionary language."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.SourceText"
|
||||
fullName: "com.azure.ai.translation.text.models.SourceText"
|
||||
name: "SourceText"
|
||||
nameWithType: "SourceText"
|
||||
summary: "Input text in the default script of the source language."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **SourceText**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.SourceText.getText()"
|
||||
fullName: "com.azure.ai.translation.text.models.SourceText.getText()"
|
||||
name: "getText()"
|
||||
nameWithType: "SourceText.getText()"
|
||||
summary: "Get the text property: Input text in the default script of the source language."
|
||||
syntax: "public String getText()"
|
||||
desc: "Get the text property: Input text in the default script of the source language."
|
||||
returns:
|
||||
description: "the text value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Input text in the default script of the source language."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TargetDictionaryLanguage"
|
||||
fullName: "com.azure.ai.translation.text.models.TargetDictionaryLanguage"
|
||||
name: "TargetDictionaryLanguage"
|
||||
nameWithType: "TargetDictionaryLanguage"
|
||||
summary: "Properties of the target dictionary language."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TargetDictionaryLanguage**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TargetDictionaryLanguage.getCode()"
|
||||
fullName: "com.azure.ai.translation.text.models.TargetDictionaryLanguage.getCode()"
|
||||
name: "getCode()"
|
||||
nameWithType: "TargetDictionaryLanguage.getCode()"
|
||||
summary: "Get the code property: Language code identifying the target language."
|
||||
syntax: "public String getCode()"
|
||||
desc: "Get the code property: Language code identifying the target language."
|
||||
returns:
|
||||
description: "the code value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TargetDictionaryLanguage.getDirectionality()"
|
||||
fullName: "com.azure.ai.translation.text.models.TargetDictionaryLanguage.getDirectionality()"
|
||||
name: "getDirectionality()"
|
||||
nameWithType: "TargetDictionaryLanguage.getDirectionality()"
|
||||
summary: "Get the directionality property: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages."
|
||||
syntax: "public LanguageDirectionality getDirectionality()"
|
||||
desc: "Get the directionality property: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages."
|
||||
returns:
|
||||
description: "the directionality value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageDirectionality?alt=com.azure.ai.translation.text.models.LanguageDirectionality&text=LanguageDirectionality\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TargetDictionaryLanguage.getName()"
|
||||
fullName: "com.azure.ai.translation.text.models.TargetDictionaryLanguage.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "TargetDictionaryLanguage.getName()"
|
||||
summary: "Get the name property: Display name of the language in the locale requested via Accept-Language header."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: Display name of the language in the locale requested via Accept-Language header."
|
||||
returns:
|
||||
description: "the name value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TargetDictionaryLanguage.getNativeName()"
|
||||
fullName: "com.azure.ai.translation.text.models.TargetDictionaryLanguage.getNativeName()"
|
||||
name: "getNativeName()"
|
||||
nameWithType: "TargetDictionaryLanguage.getNativeName()"
|
||||
summary: "Get the native<wbr>Name property: Display name of the language in the locale native for this language."
|
||||
syntax: "public String getNativeName()"
|
||||
desc: "Get the nativeName property: Display name of the language in the locale native for this language."
|
||||
returns:
|
||||
description: "the nativeName value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Properties of the target dictionary language."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TextTranslationAudience"
|
||||
fullName: "com.azure.ai.translation.text.models.TextTranslationAudience"
|
||||
name: "TextTranslationAudience"
|
||||
nameWithType: "TextTranslationAudience"
|
||||
summary: "Defines values for Text<wbr>Translation<wbr>Audience."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TextTranslationAudience**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.models.TextTranslationAudience?alt=com.azure.ai.translation.text.models.TextTranslationAudience&text=TextTranslationAudience\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.translation.text.models.TextTranslationAudience.TextTranslationAudience()"
|
||||
fullName: "com.azure.ai.translation.text.models.TextTranslationAudience.TextTranslationAudience()"
|
||||
name: "TextTranslationAudience()"
|
||||
nameWithType: "TextTranslationAudience.TextTranslationAudience()"
|
||||
summary: "Constructs a Text<wbr>Translation<wbr>Audience object."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.translation.text.models.TextTranslationAudience.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public TextTranslationAudience()"
|
||||
desc: "Constructs a TextTranslationAudience object."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.translation.text.models.TextTranslationAudience.AZURE_CHINA"
|
||||
fullName: "com.azure.ai.translation.text.models.TextTranslationAudience.AZURE_CHINA"
|
||||
name: "AZURE_CHINA"
|
||||
nameWithType: "TextTranslationAudience.AZURE_CHINA"
|
||||
summary: "Static value AZURE\\_RESOURCE\\_MANAGER\\_CHINA for Text<wbr>Translation<wbr>Audience."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextTranslationAudience?alt=com.azure.ai.translation.text.models.TextTranslationAudience&text=TextTranslationAudience\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final TextTranslationAudience AZURE_CHINA"
|
||||
desc: "Static value AZURE\\_RESOURCE\\_MANAGER\\_CHINA for TextTranslationAudience."
|
||||
- uid: "com.azure.ai.translation.text.models.TextTranslationAudience.AZURE_GOVERNMENT"
|
||||
fullName: "com.azure.ai.translation.text.models.TextTranslationAudience.AZURE_GOVERNMENT"
|
||||
name: "AZURE_GOVERNMENT"
|
||||
nameWithType: "TextTranslationAudience.AZURE_GOVERNMENT"
|
||||
summary: "Static value AZURE\\_RESOURCE\\_MANAGER\\_GOVERNMENT for Text<wbr>Translation<wbr>Audience."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextTranslationAudience?alt=com.azure.ai.translation.text.models.TextTranslationAudience&text=TextTranslationAudience\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final TextTranslationAudience AZURE_GOVERNMENT"
|
||||
desc: "Static value AZURE\\_RESOURCE\\_MANAGER\\_GOVERNMENT for TextTranslationAudience."
|
||||
- uid: "com.azure.ai.translation.text.models.TextTranslationAudience.AZURE_PUBLIC_CLOUD"
|
||||
fullName: "com.azure.ai.translation.text.models.TextTranslationAudience.AZURE_PUBLIC_CLOUD"
|
||||
name: "AZURE_PUBLIC_CLOUD"
|
||||
nameWithType: "TextTranslationAudience.AZURE_PUBLIC_CLOUD"
|
||||
summary: "Static value AZURE\\_RESOURCE\\_MANAGER\\_PUBLIC\\_CLOUD for Text<wbr>Translation<wbr>Audience."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextTranslationAudience?alt=com.azure.ai.translation.text.models.TextTranslationAudience&text=TextTranslationAudience\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final TextTranslationAudience AZURE_PUBLIC_CLOUD"
|
||||
desc: "Static value AZURE\\_RESOURCE\\_MANAGER\\_PUBLIC\\_CLOUD for TextTranslationAudience."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TextTranslationAudience.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.TextTranslationAudience.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "TextTranslationAudience.fromString(String name)"
|
||||
summary: "Creates or finds a Text<wbr>Translation<wbr>Audience from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static TextTranslationAudience fromString(String name)"
|
||||
desc: "Creates or finds a TextTranslationAudience from its string representation."
|
||||
returns:
|
||||
description: "the corresponding TextTranslationAudience."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextTranslationAudience?alt=com.azure.ai.translation.text.models.TextTranslationAudience&text=TextTranslationAudience\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TextTranslationAudience.values()"
|
||||
fullName: "com.azure.ai.translation.text.models.TextTranslationAudience.values()"
|
||||
name: "values()"
|
||||
nameWithType: "TextTranslationAudience.values()"
|
||||
summary: "Returns known Text<wbr>Translation<wbr>Audience values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<TextTranslationAudience> values()"
|
||||
desc: "Returns known TextTranslationAudience values."
|
||||
returns:
|
||||
description: "known TextTranslationAudience values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.translation.text.models.TextTranslationAudience?alt=com.azure.ai.translation.text.models.TextTranslationAudience&text=TextTranslationAudience\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Defines values for TextTranslationAudience."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TextType"
|
||||
fullName: "com.azure.ai.translation.text.models.TextType"
|
||||
name: "TextType"
|
||||
nameWithType: "TextType"
|
||||
summary: "Translation text type."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TextType**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.translation.text.models.TextType?alt=com.azure.ai.translation.text.models.TextType&text=TextType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.translation.text.models.TextType.TextType()"
|
||||
fullName: "com.azure.ai.translation.text.models.TextType.TextType()"
|
||||
name: "TextType()"
|
||||
nameWithType: "TextType.TextType()"
|
||||
summary: "Creates a new instance of Text<wbr>Type value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.translation.text.models.TextType.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public TextType()"
|
||||
desc: "Creates a new instance of TextType value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.translation.text.models.TextType.HTML"
|
||||
fullName: "com.azure.ai.translation.text.models.TextType.HTML"
|
||||
name: "HTML"
|
||||
nameWithType: "TextType.HTML"
|
||||
summary: "HTML-encoded text."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextType?alt=com.azure.ai.translation.text.models.TextType&text=TextType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final TextType HTML"
|
||||
desc: "HTML-encoded text."
|
||||
- uid: "com.azure.ai.translation.text.models.TextType.PLAIN"
|
||||
fullName: "com.azure.ai.translation.text.models.TextType.PLAIN"
|
||||
name: "PLAIN"
|
||||
nameWithType: "TextType.PLAIN"
|
||||
summary: "Plain text."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextType?alt=com.azure.ai.translation.text.models.TextType&text=TextType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final TextType PLAIN"
|
||||
desc: "Plain text."
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TextType.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.TextType.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "TextType.fromString(String name)"
|
||||
summary: "Creates or finds a Text<wbr>Type from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static TextType fromString(String name)"
|
||||
desc: "Creates or finds a TextType from its string representation."
|
||||
returns:
|
||||
description: "the corresponding TextType."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextType?alt=com.azure.ai.translation.text.models.TextType&text=TextType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TextType.values()"
|
||||
fullName: "com.azure.ai.translation.text.models.TextType.values()"
|
||||
name: "values()"
|
||||
nameWithType: "TextType.values()"
|
||||
summary: "Gets known Text<wbr>Type values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<TextType> values()"
|
||||
desc: "Gets known TextType values."
|
||||
returns:
|
||||
description: "known TextType values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.translation.text.models.TextType?alt=com.azure.ai.translation.text.models.TextType&text=TextType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Translation text type."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,307 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TranslateOptions"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions"
|
||||
name: "TranslateOptions"
|
||||
nameWithType: "TranslateOptions"
|
||||
summary: "Options that may be passed when translating a text."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TranslateOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.TranslateOptions()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.TranslateOptions()"
|
||||
name: "TranslateOptions()"
|
||||
nameWithType: "TranslateOptions.TranslateOptions()"
|
||||
syntax: "public TranslateOptions()"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.addTargetLanguage(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.addTargetLanguage(String targetLanguage)"
|
||||
name: "addTargetLanguage(String targetLanguage)"
|
||||
nameWithType: "TranslateOptions.addTargetLanguage(String targetLanguage)"
|
||||
parameters:
|
||||
- description: "Specifies the language of the output text."
|
||||
name: "targetLanguage"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TranslateOptions addTargetLanguage(String targetLanguage)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getCategory()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getCategory()"
|
||||
name: "getCategory()"
|
||||
nameWithType: "TranslateOptions.getCategory()"
|
||||
syntax: "public String getCategory()"
|
||||
returns:
|
||||
description: "specifying the category (domain) of the translation."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getClientTraceId()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getClientTraceId()"
|
||||
name: "getClientTraceId()"
|
||||
nameWithType: "TranslateOptions.getClientTraceId()"
|
||||
syntax: "public String getClientTraceId()"
|
||||
returns:
|
||||
description: "client-generated GUID to uniquely identify the request."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getProfanityAction()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getProfanityAction()"
|
||||
name: "getProfanityAction()"
|
||||
nameWithType: "TranslateOptions.getProfanityAction()"
|
||||
syntax: "public ProfanityAction getProfanityAction()"
|
||||
returns:
|
||||
description: "specifies how profanities should be treated in translations."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityAction?alt=com.azure.ai.translation.text.models.ProfanityAction&text=ProfanityAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getProfanityMarker()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getProfanityMarker()"
|
||||
name: "getProfanityMarker()"
|
||||
nameWithType: "TranslateOptions.getProfanityMarker()"
|
||||
syntax: "public ProfanityMarker getProfanityMarker()"
|
||||
returns:
|
||||
description: "specifies how profanities should be marked in translations."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityMarker?alt=com.azure.ai.translation.text.models.ProfanityMarker&text=ProfanityMarker\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getSourceLanguage()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getSourceLanguage()"
|
||||
name: "getSourceLanguage()"
|
||||
nameWithType: "TranslateOptions.getSourceLanguage()"
|
||||
syntax: "public String getSourceLanguage()"
|
||||
returns:
|
||||
description: "Specifies the language of the input text."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getSourceLanguageScript()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getSourceLanguageScript()"
|
||||
name: "getSourceLanguageScript()"
|
||||
nameWithType: "TranslateOptions.getSourceLanguageScript()"
|
||||
syntax: "public String getSourceLanguageScript()"
|
||||
returns:
|
||||
description: "the script of the input text."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getSuggestedSourceLanguage()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getSuggestedSourceLanguage()"
|
||||
name: "getSuggestedSourceLanguage()"
|
||||
nameWithType: "TranslateOptions.getSuggestedSourceLanguage()"
|
||||
syntax: "public String getSuggestedSourceLanguage()"
|
||||
returns:
|
||||
description: "fallback language if the language of the input text can't be identified."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getTargetLanguageScript()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getTargetLanguageScript()"
|
||||
name: "getTargetLanguageScript()"
|
||||
nameWithType: "TranslateOptions.getTargetLanguageScript()"
|
||||
syntax: "public String getTargetLanguageScript()"
|
||||
returns:
|
||||
description: "the script of the translated text."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getTargetLanguages()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getTargetLanguages()"
|
||||
name: "getTargetLanguages()"
|
||||
nameWithType: "TranslateOptions.getTargetLanguages()"
|
||||
syntax: "public List<String> getTargetLanguages()"
|
||||
returns:
|
||||
description: "Specifies the language of the output text."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.getTextType()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.getTextType()"
|
||||
name: "getTextType()"
|
||||
nameWithType: "TranslateOptions.getTextType()"
|
||||
syntax: "public TextType getTextType()"
|
||||
returns:
|
||||
description: "specifies whether the text being translated is plain text or HTML text."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextType?alt=com.azure.ai.translation.text.models.TextType&text=TextType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.isAllowFallback()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.isAllowFallback()"
|
||||
name: "isAllowFallback()"
|
||||
nameWithType: "TranslateOptions.isAllowFallback()"
|
||||
syntax: "public Boolean isAllowFallback()"
|
||||
returns:
|
||||
description: "Whether or not the service allows fallbeck for Custom Translator requests."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.isIncludeAlignment()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.isIncludeAlignment()"
|
||||
name: "isIncludeAlignment()"
|
||||
nameWithType: "TranslateOptions.isIncludeAlignment()"
|
||||
syntax: "public Boolean isIncludeAlignment()"
|
||||
returns:
|
||||
description: "Whether or not to include alignment projection from source text to translated text."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.isIncludeSentenceLength()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.isIncludeSentenceLength()"
|
||||
name: "isIncludeSentenceLength()"
|
||||
nameWithType: "TranslateOptions.isIncludeSentenceLength()"
|
||||
syntax: "public Boolean isIncludeSentenceLength()"
|
||||
returns:
|
||||
description: "Whether or not to include sentence boundaries for the input text and the translated text."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setAllowFallback(java.lang.Boolean)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setAllowFallback(Boolean allowFallback)"
|
||||
name: "setAllowFallback(Boolean allowFallback)"
|
||||
nameWithType: "TranslateOptions.setAllowFallback(Boolean allowFallback)"
|
||||
parameters:
|
||||
- description: "Whether or not the service allows fallbeck for Custom Translator requests."
|
||||
name: "allowFallback"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public TranslateOptions setAllowFallback(Boolean allowFallback)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setCategory(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setCategory(String category)"
|
||||
name: "setCategory(String category)"
|
||||
nameWithType: "TranslateOptions.setCategory(String category)"
|
||||
parameters:
|
||||
- description: "specifying the category (domain) of the translation."
|
||||
name: "category"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TranslateOptions setCategory(String category)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setClientTraceId(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setClientTraceId(String clientTraceId)"
|
||||
name: "setClientTraceId(String clientTraceId)"
|
||||
nameWithType: "TranslateOptions.setClientTraceId(String clientTraceId)"
|
||||
parameters:
|
||||
- description: "client-generated GUID to uniquely identify the request."
|
||||
name: "clientTraceId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TranslateOptions setClientTraceId(String clientTraceId)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setIncludeAlignment(java.lang.Boolean)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setIncludeAlignment(Boolean includeAlignment)"
|
||||
name: "setIncludeAlignment(Boolean includeAlignment)"
|
||||
nameWithType: "TranslateOptions.setIncludeAlignment(Boolean includeAlignment)"
|
||||
parameters:
|
||||
- description: "Whether or not to include alignment projection from source text to translated text."
|
||||
name: "includeAlignment"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public TranslateOptions setIncludeAlignment(Boolean includeAlignment)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setIncludeSentenceLength(java.lang.Boolean)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setIncludeSentenceLength(Boolean includeSentenceLength)"
|
||||
name: "setIncludeSentenceLength(Boolean includeSentenceLength)"
|
||||
nameWithType: "TranslateOptions.setIncludeSentenceLength(Boolean includeSentenceLength)"
|
||||
parameters:
|
||||
- description: "Whether or not to include sentence boundaries for the input text and the translated text."
|
||||
name: "includeSentenceLength"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public TranslateOptions setIncludeSentenceLength(Boolean includeSentenceLength)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setProfanityAction(com.azure.ai.translation.text.models.ProfanityAction)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setProfanityAction(ProfanityAction profanityAction)"
|
||||
name: "setProfanityAction(ProfanityAction profanityAction)"
|
||||
nameWithType: "TranslateOptions.setProfanityAction(ProfanityAction profanityAction)"
|
||||
parameters:
|
||||
- description: "specifies how profanities should be treated in translations."
|
||||
name: "profanityAction"
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityAction?alt=com.azure.ai.translation.text.models.ProfanityAction&text=ProfanityAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TranslateOptions setProfanityAction(ProfanityAction profanityAction)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setProfanityMarker(com.azure.ai.translation.text.models.ProfanityMarker)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setProfanityMarker(ProfanityMarker profanityMarker)"
|
||||
name: "setProfanityMarker(ProfanityMarker profanityMarker)"
|
||||
nameWithType: "TranslateOptions.setProfanityMarker(ProfanityMarker profanityMarker)"
|
||||
parameters:
|
||||
- description: "specifies how profanities should be marked in translations."
|
||||
name: "profanityMarker"
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.ProfanityMarker?alt=com.azure.ai.translation.text.models.ProfanityMarker&text=ProfanityMarker\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TranslateOptions setProfanityMarker(ProfanityMarker profanityMarker)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setSourceLanguage(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setSourceLanguage(String sourceLanguage)"
|
||||
name: "setSourceLanguage(String sourceLanguage)"
|
||||
nameWithType: "TranslateOptions.setSourceLanguage(String sourceLanguage)"
|
||||
parameters:
|
||||
- description: "Specifies the language of the input text."
|
||||
name: "sourceLanguage"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TranslateOptions setSourceLanguage(String sourceLanguage)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setSourceLanguageScript(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setSourceLanguageScript(String sourceLanguageScript)"
|
||||
name: "setSourceLanguageScript(String sourceLanguageScript)"
|
||||
nameWithType: "TranslateOptions.setSourceLanguageScript(String sourceLanguageScript)"
|
||||
parameters:
|
||||
- description: "the script of the input text."
|
||||
name: "sourceLanguageScript"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TranslateOptions setSourceLanguageScript(String sourceLanguageScript)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setSuggestedSourceLanguage(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setSuggestedSourceLanguage(String suggestedSourceLanguage)"
|
||||
name: "setSuggestedSourceLanguage(String suggestedSourceLanguage)"
|
||||
nameWithType: "TranslateOptions.setSuggestedSourceLanguage(String suggestedSourceLanguage)"
|
||||
parameters:
|
||||
- description: "fallback language if the language of the input text can't be identified."
|
||||
name: "suggestedSourceLanguage"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TranslateOptions setSuggestedSourceLanguage(String suggestedSourceLanguage)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setTargetLanguageScript(java.lang.String)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setTargetLanguageScript(String targetLanguageScript)"
|
||||
name: "setTargetLanguageScript(String targetLanguageScript)"
|
||||
nameWithType: "TranslateOptions.setTargetLanguageScript(String targetLanguageScript)"
|
||||
parameters:
|
||||
- description: "the script of the translated text."
|
||||
name: "targetLanguageScript"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public TranslateOptions setTargetLanguageScript(String targetLanguageScript)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setTargetLanguages(java.util.List<java.lang.String>)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setTargetLanguages(List<String> targetLanguages)"
|
||||
name: "setTargetLanguages(List<String> targetLanguages)"
|
||||
nameWithType: "TranslateOptions.setTargetLanguages(List<String> targetLanguages)"
|
||||
parameters:
|
||||
- description: "Specifies the language of the output text."
|
||||
name: "targetLanguages"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
syntax: "public TranslateOptions setTargetLanguages(List<String> targetLanguages)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslateOptions.setTextType(com.azure.ai.translation.text.models.TextType)"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslateOptions.setTextType(TextType textType)"
|
||||
name: "setTextType(TextType textType)"
|
||||
nameWithType: "TranslateOptions.setTextType(TextType textType)"
|
||||
parameters:
|
||||
- description: "specifies whether the text being translated is plain text or HTML text."
|
||||
name: "textType"
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TextType?alt=com.azure.ai.translation.text.models.TextType&text=TextType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public TranslateOptions setTextType(TextType textType)"
|
||||
returns:
|
||||
description: "The updated options."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslateOptions?alt=com.azure.ai.translation.text.models.TranslateOptions&text=TranslateOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Options that may be passed when translating a text."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TranslatedTextAlignment"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslatedTextAlignment"
|
||||
name: "TranslatedTextAlignment"
|
||||
nameWithType: "TranslatedTextAlignment"
|
||||
summary: "Alignment information object."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TranslatedTextAlignment**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TranslatedTextAlignment.getProjections()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslatedTextAlignment.getProjections()"
|
||||
name: "getProjections()"
|
||||
nameWithType: "TranslatedTextAlignment.getProjections()"
|
||||
summary: "Get the projections property: Maps input text to translated text."
|
||||
syntax: "public String getProjections()"
|
||||
desc: "Get the projections property: Maps input text to translated text. The alignment information is only provided when the request parameter includeAlignment is true. Alignment is returned as a string value of the following format: \\[\\[SourceTextStartIndex\\]:\\[SourceTextEndIndex\\]\\\\u2013\\[TgtTextStartIndex\\]:\\[TgtTextEndIndex\\]\\]. The colon separates start and end index, the dash separates the languages, and space separates the words. One word may align with zero, one, or multiple words in the other language, and the aligned words may be non-contiguous. When no alignment information is available, the alignment element will be empty."
|
||||
returns:
|
||||
description: "the projections value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Alignment information object."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TranslatedTextItem"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslatedTextItem"
|
||||
name: "TranslatedTextItem"
|
||||
nameWithType: "TranslatedTextItem"
|
||||
summary: "Element containing the translated text."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TranslatedTextItem**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TranslatedTextItem.getDetectedLanguage()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslatedTextItem.getDetectedLanguage()"
|
||||
name: "getDetectedLanguage()"
|
||||
nameWithType: "TranslatedTextItem.getDetectedLanguage()"
|
||||
summary: "Get the detected<wbr>Language property: The detected<wbr>Language property is only present in the result object when language auto-detection is requested."
|
||||
syntax: "public DetectedLanguage getDetectedLanguage()"
|
||||
desc: "Get the detectedLanguage property: The detectedLanguage property is only present in the result object when language auto-detection is requested."
|
||||
returns:
|
||||
description: "the detectedLanguage value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.DetectedLanguage?alt=com.azure.ai.translation.text.models.DetectedLanguage&text=DetectedLanguage\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslatedTextItem.getSourceText()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslatedTextItem.getSourceText()"
|
||||
name: "getSourceText()"
|
||||
nameWithType: "TranslatedTextItem.getSourceText()"
|
||||
summary: "Get the source<wbr>Text property: Input text in the default script of the source language."
|
||||
syntax: "public SourceText getSourceText()"
|
||||
desc: "Get the sourceText property: Input text in the default script of the source language. sourceText property is present only when the input is expressed in a script that's not the usual script for the language. For example, if the input were Arabic written in Latin script, then sourceText.text would be the same Arabic text converted into Arab script."
|
||||
returns:
|
||||
description: "the sourceText value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.SourceText?alt=com.azure.ai.translation.text.models.SourceText&text=SourceText\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslatedTextItem.getTranslations()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslatedTextItem.getTranslations()"
|
||||
name: "getTranslations()"
|
||||
nameWithType: "TranslatedTextItem.getTranslations()"
|
||||
summary: "Get the translations property: An array of translation results."
|
||||
syntax: "public List<TranslationText> getTranslations()"
|
||||
desc: "Get the translations property: An array of translation results. The size of the array matches the number of target languages specified through the to query parameter."
|
||||
returns:
|
||||
description: "the translations value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.translation.text.models.TranslationText?alt=com.azure.ai.translation.text.models.TranslationText&text=TranslationText\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Element containing the translated text."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TranslationLanguage"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationLanguage"
|
||||
name: "TranslationLanguage"
|
||||
nameWithType: "TranslationLanguage"
|
||||
summary: "The value of the translation property is a dictionary of (key, value) pairs."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TranslationLanguage**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TranslationLanguage.getDirectionality()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationLanguage.getDirectionality()"
|
||||
name: "getDirectionality()"
|
||||
nameWithType: "TranslationLanguage.getDirectionality()"
|
||||
summary: "Get the directionality property: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages."
|
||||
syntax: "public LanguageDirectionality getDirectionality()"
|
||||
desc: "Get the directionality property: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages."
|
||||
returns:
|
||||
description: "the directionality value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.LanguageDirectionality?alt=com.azure.ai.translation.text.models.LanguageDirectionality&text=LanguageDirectionality\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslationLanguage.getName()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationLanguage.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "TranslationLanguage.getName()"
|
||||
summary: "Get the name property: Display name of the language in the locale requested via Accept-Language header."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: Display name of the language in the locale requested via Accept-Language header."
|
||||
returns:
|
||||
description: "the name value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslationLanguage.getNativeName()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationLanguage.getNativeName()"
|
||||
name: "getNativeName()"
|
||||
nameWithType: "TranslationLanguage.getNativeName()"
|
||||
summary: "Get the native<wbr>Name property: Display name of the language in the locale native for this language."
|
||||
syntax: "public String getNativeName()"
|
||||
desc: "Get the nativeName property: Display name of the language in the locale native for this language."
|
||||
returns:
|
||||
description: "the nativeName value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "The value of the translation property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. A key identifies a language for which text can be translated to or translated from."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TranslationText"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationText"
|
||||
name: "TranslationText"
|
||||
nameWithType: "TranslationText"
|
||||
summary: "Translation result."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TranslationText**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TranslationText.getAlignment()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationText.getAlignment()"
|
||||
name: "getAlignment()"
|
||||
nameWithType: "TranslationText.getAlignment()"
|
||||
summary: "Get the alignment property: Alignment information."
|
||||
syntax: "public TranslatedTextAlignment getAlignment()"
|
||||
desc: "Get the alignment property: Alignment information."
|
||||
returns:
|
||||
description: "the alignment value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TranslatedTextAlignment?alt=com.azure.ai.translation.text.models.TranslatedTextAlignment&text=TranslatedTextAlignment\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslationText.getSentenceBoundaries()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationText.getSentenceBoundaries()"
|
||||
name: "getSentenceBoundaries()"
|
||||
nameWithType: "TranslationText.getSentenceBoundaries()"
|
||||
summary: "Get the sentence<wbr>Boundaries property: Sentence boundaries in the input and output texts."
|
||||
syntax: "public SentenceBoundaries getSentenceBoundaries()"
|
||||
desc: "Get the sentenceBoundaries property: Sentence boundaries in the input and output texts."
|
||||
returns:
|
||||
description: "the sentenceBoundaries value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.SentenceBoundaries?alt=com.azure.ai.translation.text.models.SentenceBoundaries&text=SentenceBoundaries\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslationText.getTargetLanguage()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationText.getTargetLanguage()"
|
||||
name: "getTargetLanguage()"
|
||||
nameWithType: "TranslationText.getTargetLanguage()"
|
||||
summary: "Get the target<wbr>Language property: A string representing the language code of the target language."
|
||||
syntax: "public String getTargetLanguage()"
|
||||
desc: "Get the targetLanguage property: A string representing the language code of the target language."
|
||||
returns:
|
||||
description: "the targetLanguage value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslationText.getText()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationText.getText()"
|
||||
name: "getText()"
|
||||
nameWithType: "TranslationText.getText()"
|
||||
summary: "Get the text property: A string giving the translated text."
|
||||
syntax: "public String getText()"
|
||||
desc: "Get the text property: A string giving the translated text."
|
||||
returns:
|
||||
description: "the text value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TranslationText.getTransliteration()"
|
||||
fullName: "com.azure.ai.translation.text.models.TranslationText.getTransliteration()"
|
||||
name: "getTransliteration()"
|
||||
nameWithType: "TranslationText.getTransliteration()"
|
||||
summary: "Get the transliteration property: An object giving the translated text in the script specified by the to<wbr>Script parameter."
|
||||
syntax: "public TransliteratedText getTransliteration()"
|
||||
desc: "Get the transliteration property: An object giving the translated text in the script specified by the toScript parameter."
|
||||
returns:
|
||||
description: "the transliteration value."
|
||||
type: "<xref href=\"com.azure.ai.translation.text.models.TransliteratedText?alt=com.azure.ai.translation.text.models.TransliteratedText&text=TransliteratedText\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Translation result."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TransliterableScript"
|
||||
fullName: "com.azure.ai.translation.text.models.TransliterableScript"
|
||||
name: "TransliterableScript"
|
||||
nameWithType: "TransliterableScript"
|
||||
summary: "Script definition with list of script into which given script can be translitered."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.translation.text.models.LanguageScript?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.ai.translation.text.models.LanguageScript?alt=com.azure.ai.translation.text.models.LanguageScript&text=LanguageScript\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.ai.translation.text.models.LanguageScript.getCode()?alt=com.azure.ai.translation.text.models.LanguageScript.getCode&text=getCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.translation.text.models.LanguageScript.getDirectionality()?alt=com.azure.ai.translation.text.models.LanguageScript.getDirectionality&text=getDirectionality\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.translation.text.models.LanguageScript.getName()?alt=com.azure.ai.translation.text.models.LanguageScript.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.translation.text.models.LanguageScript.getNativeName()?alt=com.azure.ai.translation.text.models.LanguageScript.getNativeName&text=getNativeName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TransliterableScript**</br> extends <xref href=\"com.azure.ai.translation.text.models.LanguageScript?alt=com.azure.ai.translation.text.models.LanguageScript&text=LanguageScript\" data-throw-if-not-resolved=\"False\" />"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TransliterableScript.getTargetLanguageScripts()"
|
||||
fullName: "com.azure.ai.translation.text.models.TransliterableScript.getTargetLanguageScripts()"
|
||||
name: "getTargetLanguageScripts()"
|
||||
nameWithType: "TransliterableScript.getTargetLanguageScripts()"
|
||||
summary: "Get the target<wbr>Language<wbr>Scripts property: List of scripts available to convert text to."
|
||||
syntax: "public List<LanguageScript> getTargetLanguageScripts()"
|
||||
desc: "Get the targetLanguageScripts property: List of scripts available to convert text to."
|
||||
returns:
|
||||
description: "the targetLanguageScripts value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.translation.text.models.LanguageScript?alt=com.azure.ai.translation.text.models.LanguageScript&text=LanguageScript\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Script definition with list of script into which given script can be translitered."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TransliteratedText"
|
||||
fullName: "com.azure.ai.translation.text.models.TransliteratedText"
|
||||
name: "TransliteratedText"
|
||||
nameWithType: "TransliteratedText"
|
||||
summary: "Transliterated text element."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TransliteratedText**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TransliteratedText.getScript()"
|
||||
fullName: "com.azure.ai.translation.text.models.TransliteratedText.getScript()"
|
||||
name: "getScript()"
|
||||
nameWithType: "TransliteratedText.getScript()"
|
||||
summary: "Get the script property: A string specifying the script used in the output."
|
||||
syntax: "public String getScript()"
|
||||
desc: "Get the script property: A string specifying the script used in the output."
|
||||
returns:
|
||||
description: "the script value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TransliteratedText.getText()"
|
||||
fullName: "com.azure.ai.translation.text.models.TransliteratedText.getText()"
|
||||
name: "getText()"
|
||||
nameWithType: "TransliteratedText.getText()"
|
||||
summary: "Get the text property: A string which is the result of converting the input string to the output script."
|
||||
syntax: "public String getText()"
|
||||
desc: "Get the text property: A string which is the result of converting the input string to the output script."
|
||||
returns:
|
||||
description: "the text value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Transliterated text element."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.translation.text.models.TransliterationLanguage"
|
||||
fullName: "com.azure.ai.translation.text.models.TransliterationLanguage"
|
||||
name: "TransliterationLanguage"
|
||||
nameWithType: "TransliterationLanguage"
|
||||
summary: "The value of the transliteration property is a dictionary of (key, value) pairs."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **TransliterationLanguage**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.translation.text.models.TransliterationLanguage.getName()"
|
||||
fullName: "com.azure.ai.translation.text.models.TransliterationLanguage.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "TransliterationLanguage.getName()"
|
||||
summary: "Get the name property: Display name of the language in the locale requested via Accept-Language header."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: Display name of the language in the locale requested via Accept-Language header."
|
||||
returns:
|
||||
description: "the name value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TransliterationLanguage.getNativeName()"
|
||||
fullName: "com.azure.ai.translation.text.models.TransliterationLanguage.getNativeName()"
|
||||
name: "getNativeName()"
|
||||
nameWithType: "TransliterationLanguage.getNativeName()"
|
||||
summary: "Get the native<wbr>Name property: Display name of the language in the locale native for this language."
|
||||
syntax: "public String getNativeName()"
|
||||
desc: "Get the nativeName property: Display name of the language in the locale native for this language."
|
||||
returns:
|
||||
description: "the nativeName value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.translation.text.models.TransliterationLanguage.getScripts()"
|
||||
fullName: "com.azure.ai.translation.text.models.TransliterationLanguage.getScripts()"
|
||||
name: "getScripts()"
|
||||
nameWithType: "TransliterationLanguage.getScripts()"
|
||||
summary: "Get the scripts property: List of scripts to convert from."
|
||||
syntax: "public List<TransliterableScript> getScripts()"
|
||||
desc: "Get the scripts property: List of scripts to convert from."
|
||||
returns:
|
||||
description: "the scripts value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.translation.text.models.TransliterableScript?alt=com.azure.ai.translation.text.models.TransliterableScript&text=TransliterableScript\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "The value of the transliteration property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. A key identifies a language for which text can be converted from one script to another script."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
### YamlMime:JavaPackage
|
||||
uid: "com.azure.ai.translation.text.models"
|
||||
fullName: "com.azure.ai.translation.text.models"
|
||||
name: "com.azure.ai.translation.text.models"
|
||||
summary: "<!-- start generated doc -->\n Package containing the data models for TextTranslation."
|
||||
classes:
|
||||
- "com.azure.ai.translation.text.models.BackTranslation"
|
||||
- "com.azure.ai.translation.text.models.BreakSentenceItem"
|
||||
- "com.azure.ai.translation.text.models.DetectedLanguage"
|
||||
- "com.azure.ai.translation.text.models.DictionaryExample"
|
||||
- "com.azure.ai.translation.text.models.DictionaryExampleItem"
|
||||
- "com.azure.ai.translation.text.models.DictionaryExampleTextItem"
|
||||
- "com.azure.ai.translation.text.models.DictionaryLookupItem"
|
||||
- "com.azure.ai.translation.text.models.DictionaryTranslation"
|
||||
- "com.azure.ai.translation.text.models.GetSupportedLanguagesResult"
|
||||
- "com.azure.ai.translation.text.models.InputTextItem"
|
||||
- "com.azure.ai.translation.text.models.LanguageScope"
|
||||
- "com.azure.ai.translation.text.models.LanguageScript"
|
||||
- "com.azure.ai.translation.text.models.SentenceBoundaries"
|
||||
- "com.azure.ai.translation.text.models.SourceDictionaryLanguage"
|
||||
- "com.azure.ai.translation.text.models.SourceText"
|
||||
- "com.azure.ai.translation.text.models.TargetDictionaryLanguage"
|
||||
- "com.azure.ai.translation.text.models.TextTranslationAudience"
|
||||
- "com.azure.ai.translation.text.models.TextType"
|
||||
- "com.azure.ai.translation.text.models.TranslateOptions"
|
||||
- "com.azure.ai.translation.text.models.TranslatedTextAlignment"
|
||||
- "com.azure.ai.translation.text.models.TranslatedTextItem"
|
||||
- "com.azure.ai.translation.text.models.TranslationLanguage"
|
||||
- "com.azure.ai.translation.text.models.TranslationText"
|
||||
- "com.azure.ai.translation.text.models.TransliterableScript"
|
||||
- "com.azure.ai.translation.text.models.TransliteratedText"
|
||||
- "com.azure.ai.translation.text.models.TransliterationLanguage"
|
||||
enums:
|
||||
- "com.azure.ai.translation.text.models.LanguageDirectionality"
|
||||
- "com.azure.ai.translation.text.models.ProfanityAction"
|
||||
- "com.azure.ai.translation.text.models.ProfanityMarker"
|
||||
desc: "<!-- start generated doc -->\n Package containing the data models for TextTranslation.\n Text translation is a cloud-based REST API feature of the Translator service that uses neural\n machine translation technology to enable quick and accurate source-to-target text translation\n in real time across all supported languages.\n\n The following methods are supported by the Text Translation feature:\n\n Languages. Returns a list of languages supported by Translate, Transliterate, and Dictionary Lookup operations.\n\n Translate. Renders single source-language text to multiple target-language texts with a single request.\n\n Transliterate. Converts characters or letters of a source language to the corresponding characters or letters of a\n target language.\n\n Detect. Returns the source code language code and a boolean variable denoting whether the detected language is\n supported for text translation and transliteration.\n\n Dictionary lookup. Returns equivalent words for the source term in the target language.\n\n Dictionary example Returns grammatical structure and context examples for the source term and target term pair.\n <!-- end generated doc -->"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text.models"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
### YamlMime:JavaPackage
|
||||
uid: "com.azure.ai.translation.text"
|
||||
fullName: "com.azure.ai.translation.text"
|
||||
name: "com.azure.ai.translation.text"
|
||||
summary: "Package containing the classes for TextTranslation."
|
||||
classes:
|
||||
- "com.azure.ai.translation.text.TextTranslationAsyncClient"
|
||||
- "com.azure.ai.translation.text.TextTranslationClient"
|
||||
- "com.azure.ai.translation.text.TextTranslationClientBuilder"
|
||||
enums:
|
||||
- "com.azure.ai.translation.text.TextTranslationServiceVersion"
|
||||
desc: "Package containing the classes for TextTranslation.\n Text translation is a cloud-based REST API feature of the Translator service that uses neural\n machine translation technology to enable quick and accurate source-to-target text translation\n in real time across all supported languages.\n\n The following methods are supported by the Text Translation feature:\n\n Languages. Returns a list of languages supported by Translate, Transliterate, and Dictionary Lookup operations.\n\n Translate. Renders single source-language text to multiple target-language texts with a single request.\n\n Transliterate. Converts characters or letters of a source language to the corresponding characters or letters of a\n target language.\n\n Detect. Returns the source code language code and a boolean variable denoting whether the detected language is\n supported for text translation and transliteration.\n\n Dictionary lookup. Returns equivalent words for the source term in the target language.\n\n Dictionary example Returns grammatical structure and context examples for the source term and target term pair."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.translation.text"
|
||||
artifact: com.azure:azure-ai-translation-text:1.0.0
|
||||
|
|
@ -822,6 +822,78 @@
|
|||
name: RecognizeLinkedEntitiesResultCollection
|
||||
- uid: com.azure.ai.textanalytics.util.RecognizePiiEntitiesResultCollection
|
||||
name: RecognizePiiEntitiesResultCollection
|
||||
- uid: com.azure.ai.translation.text.models
|
||||
name: com.azure.ai.translation.text.models
|
||||
items:
|
||||
- uid: com.azure.ai.translation.text.models.BackTranslation
|
||||
name: BackTranslation
|
||||
- uid: com.azure.ai.translation.text.models.BreakSentenceItem
|
||||
name: BreakSentenceItem
|
||||
- uid: com.azure.ai.translation.text.models.DetectedLanguage
|
||||
name: DetectedLanguage
|
||||
- uid: com.azure.ai.translation.text.models.DictionaryExample
|
||||
name: DictionaryExample
|
||||
- uid: com.azure.ai.translation.text.models.DictionaryExampleItem
|
||||
name: DictionaryExampleItem
|
||||
- uid: com.azure.ai.translation.text.models.DictionaryExampleTextItem
|
||||
name: DictionaryExampleTextItem
|
||||
- uid: com.azure.ai.translation.text.models.DictionaryLookupItem
|
||||
name: DictionaryLookupItem
|
||||
- uid: com.azure.ai.translation.text.models.DictionaryTranslation
|
||||
name: DictionaryTranslation
|
||||
- uid: com.azure.ai.translation.text.models.GetSupportedLanguagesResult
|
||||
name: GetSupportedLanguagesResult
|
||||
- uid: com.azure.ai.translation.text.models.InputTextItem
|
||||
name: InputTextItem
|
||||
- uid: com.azure.ai.translation.text.models.LanguageDirectionality
|
||||
name: LanguageDirectionality
|
||||
- uid: com.azure.ai.translation.text.models.LanguageScope
|
||||
name: LanguageScope
|
||||
- uid: com.azure.ai.translation.text.models.LanguageScript
|
||||
name: LanguageScript
|
||||
- uid: com.azure.ai.translation.text.models.ProfanityAction
|
||||
name: ProfanityAction
|
||||
- uid: com.azure.ai.translation.text.models.ProfanityMarker
|
||||
name: ProfanityMarker
|
||||
- uid: com.azure.ai.translation.text.models.SentenceBoundaries
|
||||
name: SentenceBoundaries
|
||||
- uid: com.azure.ai.translation.text.models.SourceDictionaryLanguage
|
||||
name: SourceDictionaryLanguage
|
||||
- uid: com.azure.ai.translation.text.models.SourceText
|
||||
name: SourceText
|
||||
- uid: com.azure.ai.translation.text.models.TargetDictionaryLanguage
|
||||
name: TargetDictionaryLanguage
|
||||
- uid: com.azure.ai.translation.text.models.TextTranslationAudience
|
||||
name: TextTranslationAudience
|
||||
- uid: com.azure.ai.translation.text.models.TextType
|
||||
name: TextType
|
||||
- uid: com.azure.ai.translation.text.models.TranslateOptions
|
||||
name: TranslateOptions
|
||||
- uid: com.azure.ai.translation.text.models.TranslatedTextAlignment
|
||||
name: TranslatedTextAlignment
|
||||
- uid: com.azure.ai.translation.text.models.TranslatedTextItem
|
||||
name: TranslatedTextItem
|
||||
- uid: com.azure.ai.translation.text.models.TranslationLanguage
|
||||
name: TranslationLanguage
|
||||
- uid: com.azure.ai.translation.text.models.TranslationText
|
||||
name: TranslationText
|
||||
- uid: com.azure.ai.translation.text.models.TransliterableScript
|
||||
name: TransliterableScript
|
||||
- uid: com.azure.ai.translation.text.models.TransliteratedText
|
||||
name: TransliteratedText
|
||||
- uid: com.azure.ai.translation.text.models.TransliterationLanguage
|
||||
name: TransliterationLanguage
|
||||
- uid: com.azure.ai.translation.text
|
||||
name: com.azure.ai.translation.text
|
||||
items:
|
||||
- uid: com.azure.ai.translation.text.TextTranslationAsyncClient
|
||||
name: TextTranslationAsyncClient
|
||||
- uid: com.azure.ai.translation.text.TextTranslationClient
|
||||
name: TextTranslationClient
|
||||
- uid: com.azure.ai.translation.text.TextTranslationClientBuilder
|
||||
name: TextTranslationClientBuilder
|
||||
- uid: com.azure.ai.translation.text.TextTranslationServiceVersion
|
||||
name: TextTranslationServiceVersion
|
||||
- uid: com.microsoft.azure.batch.auth
|
||||
name: com.microsoft.azure.batch.auth
|
||||
items:
|
||||
|
|
|
|||
|
|
@ -195,6 +195,11 @@
|
|||
- com.azure.ai.textanalytics
|
||||
- com.azure.ai.textanalytics.models
|
||||
- com.azure.ai.textanalytics.util
|
||||
- name: Text Translation
|
||||
href: ~/docs-ref-services/latest/ai-translation-text-readme.md
|
||||
children:
|
||||
- com.azure.ai.translation.text
|
||||
- com.azure.ai.translation.text.models
|
||||
- name: Face
|
||||
children:
|
||||
- com.microsoft.azure.cognitiveservices.vision.faceapi
|
||||
|
|
|
|||
|
|
@ -0,0 +1,353 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.FaceAsyncClient"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient"
|
||||
name: "FaceAsyncClient"
|
||||
nameWithType: "FaceAsyncClient"
|
||||
summary: "Initializes a new instance of the asynchronous Face<wbr>Client type."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceAsyncClient**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.detect(com.azure.core.util.BinaryData,com.azure.ai.vision.face.models.DetectOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.detect(BinaryData imageContent, DetectOptions options)"
|
||||
name: "detect(BinaryData imageContent, DetectOptions options)"
|
||||
nameWithType: "FaceAsyncClient.detect(BinaryData imageContent, DetectOptions options)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "The input image binary."
|
||||
name: "imageContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Options for detect API."
|
||||
name: "options"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<List<FaceDetectionResult>> detect(BinaryData imageContent, DetectOptions options)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.detect(com.azure.core.util.BinaryData,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
name: "detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
nameWithType: "FaceAsyncClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "The input image binary."
|
||||
name: "imageContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not.\n 86400 seconds. The default value is 86400 (24 hours)."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<List<FaceDetectionResult>> detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.detect(com.azure.core.util.BinaryData,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean,java.util.List<com.azure.ai.vision.face.models.FaceAttributeType>)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
name: "detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
nameWithType: "FaceAsyncClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "The input image binary."
|
||||
name: "imageContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Analyze and return the one or more specified face attributes in the comma-separated\n string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and\n time cost.\n 86400 seconds. The default value is 86400 (24 hours)."
|
||||
name: "returnFaceAttributes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public Mono<List<FaceDetectionResult>> detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.detect(com.azure.core.util.BinaryData,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean,java.util.List<com.azure.ai.vision.face.models.FaceAttributeType>,java.lang.Boolean,java.lang.Boolean,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
name: "detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
nameWithType: "FaceAsyncClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "The input image binary."
|
||||
name: "imageContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Analyze and return the one or more specified face attributes in the comma-separated\n string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and\n time cost."
|
||||
name: "returnFaceAttributes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Return face landmarks of the detected faces or not. The default value is false."
|
||||
name: "returnFaceLandmarks"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- description: "Return 'recognitionModel' or not. The default value is false."
|
||||
name: "returnRecognitionModel"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- description: "The number of seconds for the face ID being cached. Supported range from 60 seconds up to\n 86400 seconds. The default value is 86400 (24 hours)."
|
||||
name: "faceIdTimeToLive"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public Mono<List<FaceDetectionResult>> detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.detect(java.lang.String,com.azure.ai.vision.face.models.DetectOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.detect(String url, DetectOptions options)"
|
||||
name: "detect(String url, DetectOptions options)"
|
||||
nameWithType: "FaceAsyncClient.detect(String url, DetectOptions options)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "the URL of input image."
|
||||
name: "url"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "Options for detect API."
|
||||
name: "options"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<List<FaceDetectionResult>> detect(String url, DetectOptions options)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.detect(java.lang.String,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
name: "detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
nameWithType: "FaceAsyncClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "the URL of input image."
|
||||
name: "url"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<List<FaceDetectionResult>> detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.detect(java.lang.String,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean,java.util.List<com.azure.ai.vision.face.models.FaceAttributeType>)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
name: "detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
nameWithType: "FaceAsyncClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "the URL of input image."
|
||||
name: "url"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Analyze and return the one or more specified face attributes in the comma-separated\n string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and\n time cost."
|
||||
name: "returnFaceAttributes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public Mono<List<FaceDetectionResult>> detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.detect(java.lang.String,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean,java.util.List<com.azure.ai.vision.face.models.FaceAttributeType>,java.lang.Boolean,java.lang.Boolean,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
name: "detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
nameWithType: "FaceAsyncClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "the URL of input image."
|
||||
name: "url"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Analyze and return the one or more specified face attributes in the comma-separated\n string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and\n time cost."
|
||||
name: "returnFaceAttributes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Return face landmarks of the detected faces or not. The default value is false."
|
||||
name: "returnFaceLandmarks"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- description: "Return 'recognitionModel' or not. The default value is false."
|
||||
name: "returnRecognitionModel"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- description: "The number of seconds for the face ID being cached. Supported range from 60 seconds up to\n 86400 seconds. The default value is 86400 (24 hours)."
|
||||
name: "faceIdTimeToLive"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public Mono<List<FaceDetectionResult>> detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.findSimilar(java.lang.String,java.util.List<java.lang.String>)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.findSimilar(String faceId, List<String> faceIds)"
|
||||
name: "findSimilar(String faceId, List<String> faceIds)"
|
||||
nameWithType: "FaceAsyncClient.findSimilar(String faceId, List<String> faceIds)"
|
||||
summary: "Given query face's face<wbr>Id, to search the similar-looking faces from a face<wbr>Id array."
|
||||
parameters:
|
||||
- description: "faceId of the query face. User needs to call \"Detect\" first to get a valid faceId. Note that this\n faceId is not persisted and will expire 24 hours after the detection call."
|
||||
name: "faceId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "An array of candidate faceIds. All of them are created by \"Detect\" and the faceIds will expire 24\n hours after the detection call. The number of faceIds is limited to 1000."
|
||||
name: "faceIds"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
syntax: "public Mono<List<FaceFindSimilarResult>> findSimilar(String faceId, List<String> faceIds)"
|
||||
desc: "Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. Find similar has two working modes, \"matchPerson\" and \"matchFace\". \"matchPerson\" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. \"matchFace\" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target faceId array."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceFindSimilarResult?alt=com.azure.ai.vision.face.models.FaceFindSimilarResult&text=FaceFindSimilarResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.findSimilar(java.lang.String,java.util.List<java.lang.String>,java.lang.Integer,com.azure.ai.vision.face.models.FindSimilarMatchMode)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.findSimilar(String faceId, List<String> faceIds, Integer maxNumOfCandidatesReturned, FindSimilarMatchMode mode)"
|
||||
name: "findSimilar(String faceId, List<String> faceIds, Integer maxNumOfCandidatesReturned, FindSimilarMatchMode mode)"
|
||||
nameWithType: "FaceAsyncClient.findSimilar(String faceId, List<String> faceIds, Integer maxNumOfCandidatesReturned, FindSimilarMatchMode mode)"
|
||||
summary: "Given query face's face<wbr>Id, to search the similar-looking faces from a face<wbr>Id array."
|
||||
parameters:
|
||||
- description: "faceId of the query face. User needs to call \"Detect\" first to get a valid faceId. Note that this\n faceId is not persisted and will expire 24 hours after the detection call."
|
||||
name: "faceId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "An array of candidate faceIds. All of them are created by \"Detect\" and the faceIds will expire 24\n hours after the detection call. The number of faceIds is limited to 1000."
|
||||
name: "faceIds"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
- description: "The number of top similar faces returned. The valid range is [1, 1000]. Default\n value is 20."
|
||||
name: "maxNumOfCandidatesReturned"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- description: "Similar face searching mode. It can be 'matchPerson' or 'matchFace'. Default value is 'matchPerson'."
|
||||
name: "mode"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FindSimilarMatchMode?alt=com.azure.ai.vision.face.models.FindSimilarMatchMode&text=FindSimilarMatchMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<List<FaceFindSimilarResult>> findSimilar(String faceId, List<String> faceIds, Integer maxNumOfCandidatesReturned, FindSimilarMatchMode mode)"
|
||||
desc: "Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. Find similar has two working modes, \"matchPerson\" and \"matchFace\". \"matchPerson\" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. \"matchFace\" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target faceId array."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceFindSimilarResult?alt=com.azure.ai.vision.face.models.FaceFindSimilarResult&text=FaceFindSimilarResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.findSimilarWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.findSimilarWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
name: "findSimilarWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceAsyncClient.findSimilarWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
summary: "Given query face's face<wbr>Id, to search the similar-looking faces from a face<wbr>Id array."
|
||||
parameters:
|
||||
- description: "The request parameter."
|
||||
name: "request"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> findSimilarWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
desc: "Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. Find similar has two working modes, \"matchPerson\" and \"matchFace\". \"matchPerson\" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. \"matchFace\" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target faceId array.\n\n**Request Body Schema**\n\n```java\n{\n faceId: String (Required)\n maxNumOfCandidatesReturned: Integer (Optional)\n mode: String(matchPerson/matchFace) (Optional)\n faceIds (Required): [\n String (Required)\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n confidence: double (Required)\n faceId: String (Optional)\n persistedFaceId: String (Optional)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "the response body along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.group(java.util.List<java.lang.String>)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.group(List<String> faceIds)"
|
||||
name: "group(List<String> faceIds)"
|
||||
nameWithType: "FaceAsyncClient.group(List<String> faceIds)"
|
||||
summary: "Divide candidate faces into groups based on face similarity."
|
||||
parameters:
|
||||
- description: "Array of candidate faceIds created by \"Detect\". The maximum is 1000 faces."
|
||||
name: "faceIds"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
syntax: "public Mono<FaceGroupingResult> group(List<String> faceIds)"
|
||||
desc: "Divide candidate faces into groups based on face similarity. > \\* \\* The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result. \\* MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts. \\* Group API needs at least 2 candidate faces and 1000 at most. We suggest to try \"Verify Face To Face\" when you only have 2 candidate faces. \\* The 'recognitionModel' associated with the query faces' faceIds should be the same."
|
||||
returns:
|
||||
description: "response body for group face operation on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.ai.vision.face.models.FaceGroupingResult?alt=com.azure.ai.vision.face.models.FaceGroupingResult&text=FaceGroupingResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.groupWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.groupWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
name: "groupWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceAsyncClient.groupWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
summary: "Divide candidate faces into groups based on face similarity."
|
||||
parameters:
|
||||
- description: "The request parameter."
|
||||
name: "request"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> groupWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
desc: "Divide candidate faces into groups based on face similarity. > \\* \\* The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result. \\* MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts. \\* Group API needs at least 2 candidate faces and 1000 at most. We suggest to try \"Verify Face To Face\" when you only have 2 candidate faces. \\* The 'recognitionModel' associated with the query faces' faceIds should be the same.\n\n**Request Body Schema**\n\n```java\n{\n faceIds (Required): [\n String (Required)\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n groups (Required): [\n (Required)[\n String (Required)\n ]\n ]\n messyGroup (Required): [\n String (Required)\n ]\n }\n```"
|
||||
returns:
|
||||
description: "response body for group face operation along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.verifyFaceToFace(java.lang.String,java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.verifyFaceToFace(String faceId1, String faceId2)"
|
||||
name: "verifyFaceToFace(String faceId1, String faceId2)"
|
||||
nameWithType: "FaceAsyncClient.verifyFaceToFace(String faceId1, String faceId2)"
|
||||
summary: "Verify whether two faces belong to a same person."
|
||||
parameters:
|
||||
- description: "The faceId of one face, come from \"Detect\"."
|
||||
name: "faceId1"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The faceId of another face, come from \"Detect\"."
|
||||
name: "faceId2"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<FaceVerificationResult> verifyFaceToFace(String faceId1, String faceId2)"
|
||||
desc: "Verify whether two faces belong to a same person. > \\[!NOTE\\] > > \\* > \\* Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. > \\* For the scenarios that are sensitive to accuracy please make your own judgment. > \\* The 'recognitionModel' associated with the both faces should be the same."
|
||||
returns:
|
||||
description: "verify result on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.ai.vision.face.models.FaceVerificationResult?alt=com.azure.ai.vision.face.models.FaceVerificationResult&text=FaceVerificationResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceAsyncClient.verifyFaceToFaceWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceAsyncClient.verifyFaceToFaceWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
name: "verifyFaceToFaceWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceAsyncClient.verifyFaceToFaceWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
summary: "Verify whether two faces belong to a same person."
|
||||
parameters:
|
||||
- description: "The request parameter."
|
||||
name: "request"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> verifyFaceToFaceWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
desc: "Verify whether two faces belong to a same person. > \\[!NOTE\\] > > \\* > \\* Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. > \\* For the scenarios that are sensitive to accuracy please make your own judgment. > \\* The 'recognitionModel' associated with the both faces should be the same.\n\n**Request Body Schema**\n\n```java\n{\n faceId1: String (Required)\n faceId2: String (Required)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n isIdentical: boolean (Required)\n confidence: double (Required)\n }\n```"
|
||||
returns:
|
||||
description: "verify result along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
type: "class"
|
||||
desc: "Initializes a new instance of the asynchronous FaceClient type."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,353 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.FaceClient"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient"
|
||||
name: "FaceClient"
|
||||
nameWithType: "FaceClient"
|
||||
summary: "Initializes a new instance of the synchronous Face<wbr>Client type."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceClient**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.detect(com.azure.core.util.BinaryData,com.azure.ai.vision.face.models.DetectOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.detect(BinaryData imageContent, DetectOptions options)"
|
||||
name: "detect(BinaryData imageContent, DetectOptions options)"
|
||||
nameWithType: "FaceClient.detect(BinaryData imageContent, DetectOptions options)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "The input image binary."
|
||||
name: "imageContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Options for detect API."
|
||||
name: "options"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public List<FaceDetectionResult> detect(BinaryData imageContent, DetectOptions options)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.detect(com.azure.core.util.BinaryData,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
name: "detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
nameWithType: "FaceClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "The input image binary."
|
||||
name: "imageContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not. The default value is true.\n string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and\n time cost."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public List<FaceDetectionResult> detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.detect(com.azure.core.util.BinaryData,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean,java.util.List<com.azure.ai.vision.face.models.FaceAttributeType>,java.lang.Boolean,java.lang.Boolean,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
name: "detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
nameWithType: "FaceClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "The input image binary."
|
||||
name: "imageContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not. The default value is true."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Analyze and return the one or more specified face attributes in the comma-separated\n string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and\n time cost."
|
||||
name: "returnFaceAttributes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Return face landmarks of the detected faces or not. The default value is false."
|
||||
name: "returnFaceLandmarks"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- description: "Return 'recognitionModel' or not. The default value is false."
|
||||
name: "returnRecognitionModel"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- description: "The number of seconds for the face ID being cached. Supported range from 60 seconds up to\n 86400 seconds. The default value is 86400 (24 hours)."
|
||||
name: "faceIdTimeToLive"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public List<FaceDetectionResult> detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.detect(com.azure.core.util.BinaryData,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,java.lang.Boolean,java.util.List<com.azure.ai.vision.face.models.FaceAttributeType>)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, Boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
name: "detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, Boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
nameWithType: "FaceClient.detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, Boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "The input image binary."
|
||||
name: "imageContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not. The default value is true."
|
||||
name: "returnFaceId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- description: "Analyze and return the one or more specified face attributes in the comma-separated\n string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and\n time cost."
|
||||
name: "returnFaceAttributes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public List<FaceDetectionResult> detect(BinaryData imageContent, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, Boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.detect(java.lang.String,com.azure.ai.vision.face.models.DetectOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.detect(String url, DetectOptions options)"
|
||||
name: "detect(String url, DetectOptions options)"
|
||||
nameWithType: "FaceClient.detect(String url, DetectOptions options)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "the URL of input image."
|
||||
name: "url"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "Options for detectFromUrl API."
|
||||
name: "options"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public List<FaceDetectionResult> detect(String url, DetectOptions options)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.detect(java.lang.String,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
name: "detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
nameWithType: "FaceClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "the URL of input image."
|
||||
name: "url"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.\n 86400 seconds. The default value is 86400 (24 hours)."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not. The default value is true."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public List<FaceDetectionResult> detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.detect(java.lang.String,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean,java.util.List<com.azure.ai.vision.face.models.FaceAttributeType>)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
name: "detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
nameWithType: "FaceClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "the URL of input image."
|
||||
name: "url"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not. The default value is true."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Analyze and return the one or more specified face attributes in the comma-separated\n string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and\n time cost.\n 86400 seconds. The default value is 86400 (24 hours)."
|
||||
name: "returnFaceAttributes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public List<FaceDetectionResult> detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.detect(java.lang.String,com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean,java.util.List<com.azure.ai.vision.face.models.FaceAttributeType>,java.lang.Boolean,java.lang.Boolean,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
name: "detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
nameWithType: "FaceClient.detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
summary: "Detect human faces in an image, return face rectangles, and optionally with face<wbr>Ids, landmarks, and attributes."
|
||||
parameters:
|
||||
- description: "the URL of input image."
|
||||
name: "url"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'.\n 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with\n 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not. The default value is true."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Analyze and return the one or more specified face attributes in the comma-separated\n string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and\n time cost."
|
||||
name: "returnFaceAttributes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Return face landmarks of the detected faces or not. The default value is false."
|
||||
name: "returnFaceLandmarks"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- description: "Return 'recognitionModel' or not. The default value is false."
|
||||
name: "returnRecognitionModel"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- description: "The number of seconds for the face ID being cached. Supported range from 60 seconds up to\n 86400 seconds. The default value is 86400 (24 hours)."
|
||||
name: "faceIdTimeToLive"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public List<FaceDetectionResult> detect(String url, FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId, List<FaceAttributeType> returnFaceAttributes, Boolean returnFaceLandmarks, Boolean returnRecognitionModel, Integer faceIdTimeToLive)"
|
||||
desc: "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. > \\[!IMPORTANT\\] > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/en-us/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. \\* \\* No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call. \\* Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate. \\* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB. \\* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size. \\* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small. \\* For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes). \\* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-detection-model \\* 'detection\\_02': Face attributes and landmarks are disabled if you choose this detection model. \\* 'detection\\_03': Face attributes (mask and headPose only) and landmarks are supported if you choose this detection model. \\* Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition\\_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/specify-recognition-model."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionResult?alt=com.azure.ai.vision.face.models.FaceDetectionResult&text=FaceDetectionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.findSimilar(java.lang.String,java.util.List<java.lang.String>)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.findSimilar(String faceId, List<String> faceIds)"
|
||||
name: "findSimilar(String faceId, List<String> faceIds)"
|
||||
nameWithType: "FaceClient.findSimilar(String faceId, List<String> faceIds)"
|
||||
summary: "Given query face's face<wbr>Id, to search the similar-looking faces from a face<wbr>Id array."
|
||||
parameters:
|
||||
- description: "faceId of the query face. User needs to call \"Detect\" first to get a valid faceId. Note that this\n faceId is not persisted and will expire 24 hours after the detection call."
|
||||
name: "faceId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "An array of candidate faceIds. All of them are created by \"Detect\" and the faceIds will expire 24\n hours after the detection call. The number of faceIds is limited to 1000."
|
||||
name: "faceIds"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
syntax: "public List<FaceFindSimilarResult> findSimilar(String faceId, List<String> faceIds)"
|
||||
desc: "Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. Find similar has two working modes, \"matchPerson\" and \"matchFace\". \"matchPerson\" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. \"matchFace\" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target faceId array."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceFindSimilarResult?alt=com.azure.ai.vision.face.models.FaceFindSimilarResult&text=FaceFindSimilarResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.findSimilar(java.lang.String,java.util.List<java.lang.String>,java.lang.Integer,com.azure.ai.vision.face.models.FindSimilarMatchMode)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.findSimilar(String faceId, List<String> faceIds, Integer maxNumOfCandidatesReturned, FindSimilarMatchMode mode)"
|
||||
name: "findSimilar(String faceId, List<String> faceIds, Integer maxNumOfCandidatesReturned, FindSimilarMatchMode mode)"
|
||||
nameWithType: "FaceClient.findSimilar(String faceId, List<String> faceIds, Integer maxNumOfCandidatesReturned, FindSimilarMatchMode mode)"
|
||||
summary: "Given query face's face<wbr>Id, to search the similar-looking faces from a face<wbr>Id array."
|
||||
parameters:
|
||||
- description: "faceId of the query face. User needs to call \"Detect\" first to get a valid faceId. Note that this\n faceId is not persisted and will expire 24 hours after the detection call."
|
||||
name: "faceId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "An array of candidate faceIds. All of them are created by \"Detect\" and the faceIds will expire 24\n hours after the detection call. The number of faceIds is limited to 1000."
|
||||
name: "faceIds"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
- description: "The number of top similar faces returned. The valid range is [1, 1000]. Default\n value is 20."
|
||||
name: "maxNumOfCandidatesReturned"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- description: "Similar face searching mode. It can be 'matchPerson' or 'matchFace'. Default value is 'matchPerson'."
|
||||
name: "mode"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FindSimilarMatchMode?alt=com.azure.ai.vision.face.models.FindSimilarMatchMode&text=FindSimilarMatchMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public List<FaceFindSimilarResult> findSimilar(String faceId, List<String> faceIds, Integer maxNumOfCandidatesReturned, FindSimilarMatchMode mode)"
|
||||
desc: "Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. Find similar has two working modes, \"matchPerson\" and \"matchFace\". \"matchPerson\" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. \"matchFace\" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target faceId array."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceFindSimilarResult?alt=com.azure.ai.vision.face.models.FaceFindSimilarResult&text=FaceFindSimilarResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.findSimilarWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.findSimilarWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
name: "findSimilarWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceClient.findSimilarWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
summary: "Given query face's face<wbr>Id, to search the similar-looking faces from a face<wbr>Id array."
|
||||
parameters:
|
||||
- description: "The request parameter."
|
||||
name: "request"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> findSimilarWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
desc: "Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. Find similar has two working modes, \"matchPerson\" and \"matchFace\". \"matchPerson\" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. \"matchFace\" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. The 'recognitionModel' associated with the query faceId should be the same as the 'recognitionModel' used by the target faceId array.\n\n**Request Body Schema**\n\n```java\n{\n faceId: String (Required)\n maxNumOfCandidatesReturned: Integer (Optional)\n mode: String(matchPerson/matchFace) (Optional)\n faceIds (Required): [\n String (Required)\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n confidence: double (Required)\n faceId: String (Optional)\n persistedFaceId: String (Optional)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "the response body along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.group(java.util.List<java.lang.String>)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.group(List<String> faceIds)"
|
||||
name: "group(List<String> faceIds)"
|
||||
nameWithType: "FaceClient.group(List<String> faceIds)"
|
||||
summary: "Divide candidate faces into groups based on face similarity."
|
||||
parameters:
|
||||
- description: "Array of candidate faceIds created by \"Detect\". The maximum is 1000 faces."
|
||||
name: "faceIds"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
syntax: "public FaceGroupingResult group(List<String> faceIds)"
|
||||
desc: "Divide candidate faces into groups based on face similarity. > \\* \\* The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result. \\* MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts. \\* Group API needs at least 2 candidate faces and 1000 at most. We suggest to try \"Verify Face To Face\" when you only have 2 candidate faces. \\* The 'recognitionModel' associated with the query faces' faceIds should be the same."
|
||||
returns:
|
||||
description: "response body for group face operation."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceGroupingResult?alt=com.azure.ai.vision.face.models.FaceGroupingResult&text=FaceGroupingResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.groupWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.groupWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
name: "groupWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceClient.groupWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
summary: "Divide candidate faces into groups based on face similarity."
|
||||
parameters:
|
||||
- description: "The request parameter."
|
||||
name: "request"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> groupWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
desc: "Divide candidate faces into groups based on face similarity. > \\* \\* The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result. \\* MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts. \\* Group API needs at least 2 candidate faces and 1000 at most. We suggest to try \"Verify Face To Face\" when you only have 2 candidate faces. \\* The 'recognitionModel' associated with the query faces' faceIds should be the same.\n\n**Request Body Schema**\n\n```java\n{\n faceIds (Required): [\n String (Required)\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n groups (Required): [\n (Required)[\n String (Required)\n ]\n ]\n messyGroup (Required): [\n String (Required)\n ]\n }\n```"
|
||||
returns:
|
||||
description: "response body for group face operation along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.verifyFaceToFace(java.lang.String,java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.verifyFaceToFace(String faceId1, String faceId2)"
|
||||
name: "verifyFaceToFace(String faceId1, String faceId2)"
|
||||
nameWithType: "FaceClient.verifyFaceToFace(String faceId1, String faceId2)"
|
||||
summary: "Verify whether two faces belong to a same person."
|
||||
parameters:
|
||||
- description: "The faceId of one face, come from \"Detect\"."
|
||||
name: "faceId1"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The faceId of another face, come from \"Detect\"."
|
||||
name: "faceId2"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public FaceVerificationResult verifyFaceToFace(String faceId1, String faceId2)"
|
||||
desc: "Verify whether two faces belong to a same person. > \\[!NOTE\\] > > \\* > \\* Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. > \\* For the scenarios that are sensitive to accuracy please make your own judgment. > \\* The 'recognitionModel' associated with the both faces should be the same."
|
||||
returns:
|
||||
description: "verify result."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceVerificationResult?alt=com.azure.ai.vision.face.models.FaceVerificationResult&text=FaceVerificationResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClient.verifyFaceToFaceWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClient.verifyFaceToFaceWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
name: "verifyFaceToFaceWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceClient.verifyFaceToFaceWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
summary: "Verify whether two faces belong to a same person."
|
||||
parameters:
|
||||
- description: "The request parameter."
|
||||
name: "request"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> verifyFaceToFaceWithResponse(BinaryData request, RequestOptions requestOptions)"
|
||||
desc: "Verify whether two faces belong to a same person. > \\[!NOTE\\] > > \\* > \\* Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. > \\* For the scenarios that are sensitive to accuracy please make your own judgment. > \\* The 'recognitionModel' associated with the both faces should be the same.\n\n**Request Body Schema**\n\n```java\n{\n faceId1: String (Required)\n faceId2: String (Required)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n isIdentical: boolean (Required)\n confidence: double (Required)\n }\n```"
|
||||
returns:
|
||||
description: "verify result along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Initializes a new instance of the synchronous FaceClient type."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,211 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.FaceClientBuilder"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder"
|
||||
name: "FaceClientBuilder"
|
||||
nameWithType: "FaceClientBuilder"
|
||||
summary: "A builder for creating a new instance of the Face<wbr>Client type."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.FaceClientBuilder()"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.FaceClientBuilder()"
|
||||
name: "FaceClientBuilder()"
|
||||
nameWithType: "FaceClientBuilder.FaceClientBuilder()"
|
||||
summary: "Create an instance of the Face<wbr>Client<wbr>Builder."
|
||||
syntax: "public FaceClientBuilder()"
|
||||
desc: "Create an instance of the FaceClientBuilder."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
nameWithType: "FaceClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "customPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.buildAsyncClient()"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.buildAsyncClient()"
|
||||
name: "buildAsyncClient()"
|
||||
nameWithType: "FaceClientBuilder.buildAsyncClient()"
|
||||
summary: "Builds an instance of Face<wbr>Async<wbr>Client class."
|
||||
syntax: "public FaceAsyncClient buildAsyncClient()"
|
||||
desc: "Builds an instance of FaceAsyncClient class."
|
||||
returns:
|
||||
description: "an instance of FaceAsyncClient."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceAsyncClient?alt=com.azure.ai.vision.face.FaceAsyncClient&text=FaceAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.buildClient()"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.buildClient()"
|
||||
name: "buildClient()"
|
||||
nameWithType: "FaceClientBuilder.buildClient()"
|
||||
summary: "Builds an instance of Face<wbr>Client class."
|
||||
syntax: "public FaceClient buildClient()"
|
||||
desc: "Builds an instance of FaceClient class."
|
||||
returns:
|
||||
description: "an instance of FaceClient."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClient?alt=com.azure.ai.vision.face.FaceClient&text=FaceClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
name: "clientOptions(ClientOptions clientOptions)"
|
||||
nameWithType: "FaceClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "clientOptions"
|
||||
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder clientOptions(ClientOptions clientOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.configuration(Configuration configuration)"
|
||||
name: "configuration(Configuration configuration)"
|
||||
nameWithType: "FaceClientBuilder.configuration(Configuration configuration)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "configuration"
|
||||
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder configuration(Configuration configuration)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.credential(com.azure.core.credential.KeyCredential)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.credential(KeyCredential keyCredential)"
|
||||
name: "credential(KeyCredential keyCredential)"
|
||||
nameWithType: "FaceClientBuilder.credential(KeyCredential keyCredential)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "keyCredential"
|
||||
type: "<xref href=\"com.azure.core.credential.KeyCredential?alt=com.azure.core.credential.KeyCredential&text=KeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder credential(KeyCredential keyCredential)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
name: "credential(TokenCredential tokenCredential)"
|
||||
nameWithType: "FaceClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "tokenCredential"
|
||||
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder credential(TokenCredential tokenCredential)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.endpoint(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.endpoint(String endpoint)"
|
||||
name: "endpoint(String endpoint)"
|
||||
nameWithType: "FaceClientBuilder.endpoint(String endpoint)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "endpoint"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public FaceClientBuilder endpoint(String endpoint)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.httpClient(HttpClient httpClient)"
|
||||
name: "httpClient(HttpClient httpClient)"
|
||||
nameWithType: "FaceClientBuilder.httpClient(HttpClient httpClient)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpClient"
|
||||
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder httpClient(HttpClient httpClient)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
nameWithType: "FaceClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpLogOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
name: "pipeline(HttpPipeline pipeline)"
|
||||
nameWithType: "FaceClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "pipeline"
|
||||
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder pipeline(HttpPipeline pipeline)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
name: "retryOptions(RetryOptions retryOptions)"
|
||||
nameWithType: "FaceClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "retryOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder retryOptions(RetryOptions retryOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
name: "retryPolicy(RetryPolicy retryPolicy)"
|
||||
nameWithType: "FaceClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
summary: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
parameters:
|
||||
- description: "the retryPolicy value."
|
||||
name: "retryPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryPolicy?alt=com.azure.core.http.policy.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
||||
desc: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
returns:
|
||||
description: "the FaceClientBuilder."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceClientBuilder.serviceVersion(com.azure.ai.vision.face.FaceServiceVersion)"
|
||||
fullName: "com.azure.ai.vision.face.FaceClientBuilder.serviceVersion(FaceServiceVersion serviceVersion)"
|
||||
name: "serviceVersion(FaceServiceVersion serviceVersion)"
|
||||
nameWithType: "FaceClientBuilder.serviceVersion(FaceServiceVersion serviceVersion)"
|
||||
summary: "Sets Service version."
|
||||
parameters:
|
||||
- description: "the serviceVersion value."
|
||||
name: "serviceVersion"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceServiceVersion?alt=com.azure.ai.vision.face.FaceServiceVersion&text=FaceServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceClientBuilder serviceVersion(FaceServiceVersion serviceVersion)"
|
||||
desc: "Sets Service version."
|
||||
returns:
|
||||
description: "the FaceClientBuilder."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A builder for creating a new instance of the FaceClient type."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceClientBuilder?alt=com.azure.ai.vision.face.FaceClientBuilder&text=FaceClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
### YamlMime:JavaEnum
|
||||
uid: "com.azure.ai.vision.face.FaceServiceVersion"
|
||||
fullName: "com.azure.ai.vision.face.FaceServiceVersion"
|
||||
name: "FaceServiceVersion"
|
||||
nameWithType: "FaceServiceVersion"
|
||||
summary: "Service version of Face<wbr>Client."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-\">valueOf</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-\">compareTo</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--\">getDeclaringClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--\">name</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--\">ordinal</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--\">toString</a>"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public enum **FaceServiceVersion**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.ai.vision.face.FaceServiceVersion?alt=com.azure.ai.vision.face.FaceServiceVersion&text=FaceServiceVersion\" data-throw-if-not-resolved=\"False\" />></br> implements <xref href=\"com.azure.core.util.ServiceVersion?alt=com.azure.core.util.ServiceVersion&text=ServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.FaceServiceVersion.V1_1_PREVIEW_1"
|
||||
fullName: "com.azure.ai.vision.face.FaceServiceVersion.V1_1_PREVIEW_1"
|
||||
name: "V1_1_PREVIEW_1"
|
||||
nameWithType: "FaceServiceVersion.V1_1_PREVIEW_1"
|
||||
summary: "Enum value v1.1-preview.1."
|
||||
desc: "Enum value v1.1-preview.1."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.FaceServiceVersion.getLatest()"
|
||||
fullName: "com.azure.ai.vision.face.FaceServiceVersion.getLatest()"
|
||||
name: "getLatest()"
|
||||
nameWithType: "FaceServiceVersion.getLatest()"
|
||||
summary: "Gets the latest service version supported by this client library."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static FaceServiceVersion getLatest()"
|
||||
desc: "Gets the latest service version supported by this client library."
|
||||
returns:
|
||||
description: "The latest <xref uid=\"com.azure.ai.vision.face.FaceServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FaceServiceVersion\"></xref>."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceServiceVersion?alt=com.azure.ai.vision.face.FaceServiceVersion&text=FaceServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceServiceVersion.getVersion()"
|
||||
fullName: "com.azure.ai.vision.face.FaceServiceVersion.getVersion()"
|
||||
name: "getVersion()"
|
||||
nameWithType: "FaceServiceVersion.getVersion()"
|
||||
syntax: "public String getVersion()"
|
||||
returns:
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.FaceServiceVersion.valueOf(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceServiceVersion.valueOf(String name)"
|
||||
name: "valueOf(String name)"
|
||||
nameWithType: "FaceServiceVersion.valueOf(String name)"
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FaceServiceVersion valueOf(String name)"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceServiceVersion?alt=com.azure.ai.vision.face.FaceServiceVersion&text=FaceServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceServiceVersion.values()"
|
||||
fullName: "com.azure.ai.vision.face.FaceServiceVersion.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FaceServiceVersion.values()"
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static FaceServiceVersion[] values()"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceServiceVersion?alt=com.azure.ai.vision.face.FaceServiceVersion&text=FaceServiceVersion\" data-throw-if-not-resolved=\"False\" />[]"
|
||||
desc: "Service version of FaceClient."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.util.ServiceVersion?alt=com.azure.core.util.ServiceVersion&text=ServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,385 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.FaceSessionAsyncClient"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient"
|
||||
name: "FaceSessionAsyncClient"
|
||||
nameWithType: "FaceSessionAsyncClient"
|
||||
summary: "Initializes a new instance of the asynchronous Face<wbr>Session<wbr>Client type."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceSessionAsyncClient**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.createLivenessSession(com.azure.ai.vision.face.models.CreateLivenessSessionContent)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.createLivenessSession(CreateLivenessSessionContent createLivenessSessionContent)"
|
||||
name: "createLivenessSession(CreateLivenessSessionContent createLivenessSessionContent)"
|
||||
nameWithType: "FaceSessionAsyncClient.createLivenessSession(CreateLivenessSessionContent createLivenessSessionContent)"
|
||||
summary: "Create a new detect liveness session."
|
||||
parameters:
|
||||
- description: "Request for creating liveness session."
|
||||
name: "createLivenessSessionContent"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionContent?alt=com.azure.ai.vision.face.models.CreateLivenessSessionContent&text=CreateLivenessSessionContent\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<CreateLivenessSessionResult> createLivenessSession(CreateLivenessSessionContent createLivenessSessionContent)"
|
||||
desc: "Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired. Permissions includes... > \\* \\* Ability to call /detectLiveness/singleModal for up to 3 retries. \\* A token lifetime of 10 minutes. > \\[!NOTE\\] > Client access can be revoked by deleting the session using the Delete Liveness Session operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries."
|
||||
returns:
|
||||
description: "response of liveness session creation on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionResult?alt=com.azure.ai.vision.face.models.CreateLivenessSessionResult&text=CreateLivenessSessionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.createLivenessSessionWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.createLivenessSessionWithResponse(BinaryData createLivenessSessionContent, RequestOptions requestOptions)"
|
||||
name: "createLivenessSessionWithResponse(BinaryData createLivenessSessionContent, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionAsyncClient.createLivenessSessionWithResponse(BinaryData createLivenessSessionContent, RequestOptions requestOptions)"
|
||||
summary: "Create a new detect liveness session."
|
||||
parameters:
|
||||
- description: "Request for creating liveness session."
|
||||
name: "createLivenessSessionContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> createLivenessSessionWithResponse(BinaryData createLivenessSessionContent, RequestOptions requestOptions)"
|
||||
desc: "Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired. Permissions includes... > \\* \\* Ability to call /detectLiveness/singleModal for up to 3 retries. \\* A token lifetime of 10 minutes. > \\[!NOTE\\] > Client access can be revoked by deleting the session using the Delete Liveness Session operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries.\n\n**Request Body Schema**\n\n```java\n{\n livenessOperationMode: String(Passive/PassiveActive) (Required)\n sendResultsToClient: Boolean (Optional)\n deviceCorrelationIdSetInClient: Boolean (Optional)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n sessionId: String (Required)\n authToken: String (Required)\n }\n```"
|
||||
returns:
|
||||
description: "response of liveness session creation along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.createLivenessWithVerifySession(com.azure.ai.vision.face.models.CreateLivenessSessionContent,com.azure.core.util.BinaryData)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.createLivenessWithVerifySession(CreateLivenessSessionContent createLivenessSessionParameters, BinaryData verifyImage)"
|
||||
name: "createLivenessWithVerifySession(CreateLivenessSessionContent createLivenessSessionParameters, BinaryData verifyImage)"
|
||||
nameWithType: "FaceSessionAsyncClient.createLivenessWithVerifySession(CreateLivenessSessionContent createLivenessSessionParameters, BinaryData verifyImage)"
|
||||
summary: "Create a new liveness session with verify."
|
||||
parameters:
|
||||
- description: "Request for creating liveness session."
|
||||
name: "createLivenessSessionParameters"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionContent?alt=com.azure.ai.vision.face.models.CreateLivenessSessionContent&text=CreateLivenessSessionContent\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "the content value of the verify image."
|
||||
name: "verifyImage"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<CreateLivenessWithVerifySessionResult> createLivenessWithVerifySession(CreateLivenessSessionContent createLivenessSessionParameters, BinaryData verifyImage)"
|
||||
desc: "Create a new liveness session with verify. Client device submits VerifyImage during the /detectLivenessWithVerify/singleModal call. A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired. Permissions includes... > \\* \\* Ability to call /detectLivenessWithVerify/singleModal for up to 3 retries. \\* A token lifetime of 10 minutes. > \\[!NOTE\\] > > \\* > \\* Client access can be revoked by deleting the session using the Delete Liveness With Verify Session operation. > \\* To retrieve a result, use the Get Liveness With Verify Session. > \\* To audit the individual requests that a client has made to your resource, use the List Liveness With Verify Session Audit Entries. Alternative Option: Client device submits VerifyImage during the /detectLivenessWithVerify/singleModal call. > \\[!NOTE\\] > Extra measures should be taken to validate that the client is sending the expected VerifyImage."
|
||||
returns:
|
||||
description: "response of liveness session with verify creation with verify image provided on successful completion of\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult?alt=com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult&text=CreateLivenessWithVerifySessionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.deleteLivenessSession(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.deleteLivenessSession(String sessionId)"
|
||||
name: "deleteLivenessSession(String sessionId)"
|
||||
nameWithType: "FaceSessionAsyncClient.deleteLivenessSession(String sessionId)"
|
||||
summary: "Delete all session related information for matching the specified session id."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<Void> deleteLivenessSession(String sessionId)"
|
||||
desc: "Delete all session related information for matching the specified session id. > \\[!NOTE\\] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused."
|
||||
returns:
|
||||
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that completes when a successful response is received."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.deleteLivenessSessionWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.deleteLivenessSessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "deleteLivenessSessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionAsyncClient.deleteLivenessSessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Delete all session related information for matching the specified session id."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<Void>> deleteLivenessSessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Delete all session related information for matching the specified session id. > \\[!NOTE\\] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused."
|
||||
returns:
|
||||
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.deleteLivenessWithVerifySession(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.deleteLivenessWithVerifySession(String sessionId)"
|
||||
name: "deleteLivenessWithVerifySession(String sessionId)"
|
||||
nameWithType: "FaceSessionAsyncClient.deleteLivenessWithVerifySession(String sessionId)"
|
||||
summary: "Delete all session related information for matching the specified session id."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<Void> deleteLivenessWithVerifySession(String sessionId)"
|
||||
desc: "Delete all session related information for matching the specified session id. > \\[!NOTE\\] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused."
|
||||
returns:
|
||||
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that completes when a successful response is received."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.deleteLivenessWithVerifySessionWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.deleteLivenessWithVerifySessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "deleteLivenessWithVerifySessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionAsyncClient.deleteLivenessWithVerifySessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Delete all session related information for matching the specified session id."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<Void>> deleteLivenessWithVerifySessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Delete all session related information for matching the specified session id. > \\[!NOTE\\] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused."
|
||||
returns:
|
||||
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionAuditEntries(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionAuditEntries(String sessionId)"
|
||||
name: "getLivenessSessionAuditEntries(String sessionId)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessSessionAuditEntries(String sessionId)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<List<LivenessSessionAuditEntry>> getLivenessSessionAuditEntries(String sessionId)"
|
||||
desc: "Gets session requests and response body for the session."
|
||||
returns:
|
||||
description: "session requests and response body for the session on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionAuditEntries(java.lang.String,java.lang.String,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
name: "getLivenessSessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessSessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."
|
||||
name: "start"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The number of items to list, ranging in [1, 1000]. Default is 1000."
|
||||
name: "top"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public Mono<List<LivenessSessionAuditEntry>> getLivenessSessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
desc: "Gets session requests and response body for the session."
|
||||
returns:
|
||||
description: "session requests and response body for the session on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionAuditEntriesWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "getLivenessSessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessSessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> getLivenessSessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Gets session requests and response body for the session.\n\n**Query Parameters**\n\n | ----- | ------- | -------- | -------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | start | String | No | List resources greater than the \"start\". It contains no more than 64 characters. Default is empty. |\n | top | Integer | No | The number of items to list, ranging in \\[1, 1000\\]. Default is 1000. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n id: long (Required)\n sessionId: String (Required)\n requestId: String (Required)\n clientRequestId: String (Required)\n receivedDateTime: OffsetDateTime (Required)\n request (Required): {\n url: String (Required)\n method: String (Required)\n contentLength: Long (Optional)\n contentType: String (Required)\n userAgent: String (Optional)\n }\n response (Required): {\n body (Required): {\n livenessDecision: String(uncertain/realface/spoofface) (Optional)\n target (Optional): {\n faceRectangle (Required): {\n top: int (Required)\n left: int (Required)\n width: int (Required)\n height: int (Required)\n }\n fileName: String (Required)\n timeOffsetWithinFile: int (Required)\n imageType: String(Color/Infrared/Depth) (Required)\n }\n modelVersionUsed: String(2020-02-15-preview.01/2021-11-12-preview.03/2022-10-15-preview.04/2023-03-02-preview.05) (Optional)\n verifyResult (Optional): {\n verifyImage (Required): {\n faceRectangle (Required): (recursive schema, see faceRectangle above)\n qualityForRecognition: String(low/medium/high) (Required)\n }\n matchConfidence: double (Required)\n isIdentical: boolean (Required)\n }\n (Optional): {\n String: Object (Required)\n }\n }\n statusCode: int (Required)\n latencyInMilliseconds: long (Required)\n }\n digest: String (Required)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "session requests and response body for the session along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion\n of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionResult(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionResult(String sessionId)"
|
||||
name: "getLivenessSessionResult(String sessionId)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessSessionResult(String sessionId)"
|
||||
summary: "Get session result of detect<wbr>Liveness/single<wbr>Modal call."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<LivenessSession> getLivenessSessionResult(String sessionId)"
|
||||
desc: "Get session result of detectLiveness/singleModal call."
|
||||
returns:
|
||||
description: "session result of detectLiveness/singleModal call on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSession?alt=com.azure.ai.vision.face.models.LivenessSession&text=LivenessSession\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionResultWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "getLivenessSessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessSessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Get session result of detect<wbr>Liveness/single<wbr>Modal call."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> getLivenessSessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Get session result of detectLiveness/singleModal call.\n\n**Response Body Schema**\n\n```java\n{\n id: String (Required)\n createdDateTime: OffsetDateTime (Required)\n sessionStartDateTime: OffsetDateTime (Optional)\n sessionExpired: boolean (Required)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n status: String(NotStarted/Started/ResultAvailable) (Required)\n result (Optional): {\n id: long (Required)\n sessionId: String (Required)\n requestId: String (Required)\n clientRequestId: String (Required)\n receivedDateTime: OffsetDateTime (Required)\n request (Required): {\n url: String (Required)\n method: String (Required)\n contentLength: Long (Optional)\n contentType: String (Required)\n userAgent: String (Optional)\n }\n response (Required): {\n body (Required): {\n livenessDecision: String(uncertain/realface/spoofface) (Optional)\n target (Optional): {\n faceRectangle (Required): {\n top: int (Required)\n left: int (Required)\n width: int (Required)\n height: int (Required)\n }\n fileName: String (Required)\n timeOffsetWithinFile: int (Required)\n imageType: String(Color/Infrared/Depth) (Required)\n }\n modelVersionUsed: String(2020-02-15-preview.01/2021-11-12-preview.03/2022-10-15-preview.04/2023-03-02-preview.05) (Optional)\n verifyResult (Optional): {\n verifyImage (Required): {\n faceRectangle (Required): (recursive schema, see faceRectangle above)\n qualityForRecognition: String(low/medium/high) (Required)\n }\n matchConfidence: double (Required)\n isIdentical: boolean (Required)\n }\n (Optional): {\n String: Object (Required)\n }\n }\n statusCode: int (Required)\n latencyInMilliseconds: long (Required)\n }\n digest: String (Required)\n }\n }\n```"
|
||||
returns:
|
||||
description: "session result of detectLiveness/singleModal call along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessions()"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessions()"
|
||||
name: "getLivenessSessions()"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessSessions()"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness/Single<wbr>Modal."
|
||||
syntax: "public Mono<List<LivenessSessionItem>> getLivenessSessions()"
|
||||
desc: "Lists sessions for /detectLiveness/SingleModal. List sessions from the last sessionId greater than the 'start'. The result should be ordered by sessionId in ascending order."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionItem?alt=com.azure.ai.vision.face.models.LivenessSessionItem&text=LivenessSessionItem\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessions(java.lang.String,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessions(String start, Integer top)"
|
||||
name: "getLivenessSessions(String start, Integer top)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessSessions(String start, Integer top)"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness/Single<wbr>Modal."
|
||||
parameters:
|
||||
- description: "List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."
|
||||
name: "start"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The number of items to list, ranging in [1, 1000]. Default is 1000."
|
||||
name: "top"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public Mono<List<LivenessSessionItem>> getLivenessSessions(String start, Integer top)"
|
||||
desc: "Lists sessions for /detectLiveness/SingleModal. List sessions from the last sessionId greater than the 'start'. The result should be ordered by sessionId in ascending order."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionItem?alt=com.azure.ai.vision.face.models.LivenessSessionItem&text=LivenessSessionItem\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionsWithResponse(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessSessionsWithResponse(RequestOptions requestOptions)"
|
||||
name: "getLivenessSessionsWithResponse(RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessSessionsWithResponse(RequestOptions requestOptions)"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness/Single<wbr>Modal."
|
||||
parameters:
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> getLivenessSessionsWithResponse(RequestOptions requestOptions)"
|
||||
desc: "Lists sessions for /detectLiveness/SingleModal. List sessions from the last sessionId greater than the 'start'. The result should be ordered by sessionId in ascending order.\n\n**Query Parameters**\n\n | ----- | ------- | -------- | -------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | start | String | No | List resources greater than the \"start\". It contains no more than 64 characters. Default is empty. |\n | top | Integer | No | The number of items to list, ranging in \\[1, 1000\\]. Default is 1000. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n id: String (Required)\n createdDateTime: OffsetDateTime (Required)\n sessionStartDateTime: OffsetDateTime (Optional)\n sessionExpired: boolean (Required)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "the response body along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionAuditEntries(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionAuditEntries(String sessionId)"
|
||||
name: "getLivenessWithVerifySessionAuditEntries(String sessionId)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessWithVerifySessionAuditEntries(String sessionId)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<List<LivenessSessionAuditEntry>> getLivenessWithVerifySessionAuditEntries(String sessionId)"
|
||||
desc: "Gets session requests and response body for the session."
|
||||
returns:
|
||||
description: "session requests and response body for the session on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionAuditEntries(java.lang.String,java.lang.String,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
name: "getLivenessWithVerifySessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessWithVerifySessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."
|
||||
name: "start"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The number of items to list, ranging in [1, 1000]. Default is 1000."
|
||||
name: "top"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public Mono<List<LivenessSessionAuditEntry>> getLivenessWithVerifySessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
desc: "Gets session requests and response body for the session."
|
||||
returns:
|
||||
description: "session requests and response body for the session on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionAuditEntriesWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "getLivenessWithVerifySessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessWithVerifySessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> getLivenessWithVerifySessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Gets session requests and response body for the session.\n\n**Query Parameters**\n\n | ----- | ------- | -------- | -------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | start | String | No | List resources greater than the \"start\". It contains no more than 64 characters. Default is empty. |\n | top | Integer | No | The number of items to list, ranging in \\[1, 1000\\]. Default is 1000. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n id: long (Required)\n sessionId: String (Required)\n requestId: String (Required)\n clientRequestId: String (Required)\n receivedDateTime: OffsetDateTime (Required)\n request (Required): {\n url: String (Required)\n method: String (Required)\n contentLength: Long (Optional)\n contentType: String (Required)\n userAgent: String (Optional)\n }\n response (Required): {\n body (Required): {\n livenessDecision: String(uncertain/realface/spoofface) (Optional)\n target (Optional): {\n faceRectangle (Required): {\n top: int (Required)\n left: int (Required)\n width: int (Required)\n height: int (Required)\n }\n fileName: String (Required)\n timeOffsetWithinFile: int (Required)\n imageType: String(Color/Infrared/Depth) (Required)\n }\n modelVersionUsed: String(2020-02-15-preview.01/2021-11-12-preview.03/2022-10-15-preview.04/2023-03-02-preview.05) (Optional)\n verifyResult (Optional): {\n verifyImage (Required): {\n faceRectangle (Required): (recursive schema, see faceRectangle above)\n qualityForRecognition: String(low/medium/high) (Required)\n }\n matchConfidence: double (Required)\n isIdentical: boolean (Required)\n }\n (Optional): {\n String: Object (Required)\n }\n }\n statusCode: int (Required)\n latencyInMilliseconds: long (Required)\n }\n digest: String (Required)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "session requests and response body for the session along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion\n of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionResult(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionResult(String sessionId)"
|
||||
name: "getLivenessWithVerifySessionResult(String sessionId)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessWithVerifySessionResult(String sessionId)"
|
||||
summary: "Get session result of detect<wbr>Liveness<wbr>With<wbr>Verify/single<wbr>Modal call."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<LivenessWithVerifySession> getLivenessWithVerifySessionResult(String sessionId)"
|
||||
desc: "Get session result of detectLivenessWithVerify/singleModal call."
|
||||
returns:
|
||||
description: "session result of detectLivenessWithVerify/singleModal call on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.ai.vision.face.models.LivenessWithVerifySession?alt=com.azure.ai.vision.face.models.LivenessWithVerifySession&text=LivenessWithVerifySession\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionResultWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "getLivenessWithVerifySessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessWithVerifySessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Get session result of detect<wbr>Liveness<wbr>With<wbr>Verify/single<wbr>Modal call."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> getLivenessWithVerifySessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Get session result of detectLivenessWithVerify/singleModal call.\n\n**Response Body Schema**\n\n```java\n{\n id: String (Required)\n createdDateTime: OffsetDateTime (Required)\n sessionStartDateTime: OffsetDateTime (Optional)\n sessionExpired: boolean (Required)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n status: String(NotStarted/Started/ResultAvailable) (Required)\n result (Optional): {\n id: long (Required)\n sessionId: String (Required)\n requestId: String (Required)\n clientRequestId: String (Required)\n receivedDateTime: OffsetDateTime (Required)\n request (Required): {\n url: String (Required)\n method: String (Required)\n contentLength: Long (Optional)\n contentType: String (Required)\n userAgent: String (Optional)\n }\n response (Required): {\n body (Required): {\n livenessDecision: String(uncertain/realface/spoofface) (Optional)\n target (Optional): {\n faceRectangle (Required): {\n top: int (Required)\n left: int (Required)\n width: int (Required)\n height: int (Required)\n }\n fileName: String (Required)\n timeOffsetWithinFile: int (Required)\n imageType: String(Color/Infrared/Depth) (Required)\n }\n modelVersionUsed: String(2020-02-15-preview.01/2021-11-12-preview.03/2022-10-15-preview.04/2023-03-02-preview.05) (Optional)\n verifyResult (Optional): {\n verifyImage (Required): {\n faceRectangle (Required): (recursive schema, see faceRectangle above)\n qualityForRecognition: String(low/medium/high) (Required)\n }\n matchConfidence: double (Required)\n isIdentical: boolean (Required)\n }\n (Optional): {\n String: Object (Required)\n }\n }\n statusCode: int (Required)\n latencyInMilliseconds: long (Required)\n }\n digest: String (Required)\n }\n }\n```"
|
||||
returns:
|
||||
description: "session result of detectLivenessWithVerify/singleModal call along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful\n completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessions()"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessions()"
|
||||
name: "getLivenessWithVerifySessions()"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessWithVerifySessions()"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness<wbr>With<wbr>Verify/Single<wbr>Modal."
|
||||
syntax: "public Mono<List<LivenessSessionItem>> getLivenessWithVerifySessions()"
|
||||
desc: "Lists sessions for /detectLivenessWithVerify/SingleModal. List sessions from the last sessionId greater than the \"start\". The result should be ordered by sessionId in ascending order."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionItem?alt=com.azure.ai.vision.face.models.LivenessSessionItem&text=LivenessSessionItem\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessions(java.lang.String,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessions(String start, Integer top)"
|
||||
name: "getLivenessWithVerifySessions(String start, Integer top)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessWithVerifySessions(String start, Integer top)"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness<wbr>With<wbr>Verify/Single<wbr>Modal."
|
||||
parameters:
|
||||
- description: "List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."
|
||||
name: "start"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The number of items to list, ranging in [1, 1000]. Default is 1000."
|
||||
name: "top"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public Mono<List<LivenessSessionItem>> getLivenessWithVerifySessions(String start, Integer top)"
|
||||
desc: "Lists sessions for /detectLivenessWithVerify/SingleModal. List sessions from the last sessionId greater than the \"start\". The result should be ordered by sessionId in ascending order."
|
||||
returns:
|
||||
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionItem?alt=com.azure.ai.vision.face.models.LivenessSessionItem&text=LivenessSessionItem\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionsWithResponse(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionAsyncClient.getLivenessWithVerifySessionsWithResponse(RequestOptions requestOptions)"
|
||||
name: "getLivenessWithVerifySessionsWithResponse(RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionAsyncClient.getLivenessWithVerifySessionsWithResponse(RequestOptions requestOptions)"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness<wbr>With<wbr>Verify/Single<wbr>Modal."
|
||||
parameters:
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<BinaryData>> getLivenessWithVerifySessionsWithResponse(RequestOptions requestOptions)"
|
||||
desc: "Lists sessions for /detectLivenessWithVerify/SingleModal. List sessions from the last sessionId greater than the \"start\". The result should be ordered by sessionId in ascending order.\n\n**Query Parameters**\n\n | ----- | ------- | -------- | -------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | start | String | No | List resources greater than the \"start\". It contains no more than 64 characters. Default is empty. |\n | top | Integer | No | The number of items to list, ranging in \\[1, 1000\\]. Default is 1000. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n id: String (Required)\n createdDateTime: OffsetDateTime (Required)\n sessionStartDateTime: OffsetDateTime (Optional)\n sessionExpired: boolean (Required)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "the response body along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
type: "class"
|
||||
desc: "Initializes a new instance of the asynchronous FaceSessionClient type."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,379 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.FaceSessionClient"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient"
|
||||
name: "FaceSessionClient"
|
||||
nameWithType: "FaceSessionClient"
|
||||
summary: "Initializes a new instance of the synchronous Face<wbr>Session<wbr>Client type."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceSessionClient**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.createLivenessSession(com.azure.ai.vision.face.models.CreateLivenessSessionContent)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.createLivenessSession(CreateLivenessSessionContent createLivenessSessionContent)"
|
||||
name: "createLivenessSession(CreateLivenessSessionContent createLivenessSessionContent)"
|
||||
nameWithType: "FaceSessionClient.createLivenessSession(CreateLivenessSessionContent createLivenessSessionContent)"
|
||||
summary: "Create a new detect liveness session."
|
||||
parameters:
|
||||
- description: "Request for creating liveness session."
|
||||
name: "createLivenessSessionContent"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionContent?alt=com.azure.ai.vision.face.models.CreateLivenessSessionContent&text=CreateLivenessSessionContent\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public CreateLivenessSessionResult createLivenessSession(CreateLivenessSessionContent createLivenessSessionContent)"
|
||||
desc: "Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired. Permissions includes... > \\* \\* Ability to call /detectLiveness/singleModal for up to 3 retries. \\* A token lifetime of 10 minutes. > \\[!NOTE\\] > Client access can be revoked by deleting the session using the Delete Liveness Session operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries."
|
||||
returns:
|
||||
description: "response of liveness session creation."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionResult?alt=com.azure.ai.vision.face.models.CreateLivenessSessionResult&text=CreateLivenessSessionResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.createLivenessSessionWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.createLivenessSessionWithResponse(BinaryData createLivenessSessionContent, RequestOptions requestOptions)"
|
||||
name: "createLivenessSessionWithResponse(BinaryData createLivenessSessionContent, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionClient.createLivenessSessionWithResponse(BinaryData createLivenessSessionContent, RequestOptions requestOptions)"
|
||||
summary: "Create a new detect liveness session."
|
||||
parameters:
|
||||
- description: "Request for creating liveness session."
|
||||
name: "createLivenessSessionContent"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> createLivenessSessionWithResponse(BinaryData createLivenessSessionContent, RequestOptions requestOptions)"
|
||||
desc: "Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired. Permissions includes... > \\* \\* Ability to call /detectLiveness/singleModal for up to 3 retries. \\* A token lifetime of 10 minutes. > \\[!NOTE\\] > Client access can be revoked by deleting the session using the Delete Liveness Session operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries.\n\n**Request Body Schema**\n\n```java\n{\n livenessOperationMode: String(Passive/PassiveActive) (Required)\n sendResultsToClient: Boolean (Optional)\n deviceCorrelationIdSetInClient: Boolean (Optional)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n sessionId: String (Required)\n authToken: String (Required)\n }\n```"
|
||||
returns:
|
||||
description: "response of liveness session creation along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.createLivenessWithVerifySession(com.azure.ai.vision.face.models.CreateLivenessSessionContent,com.azure.core.util.BinaryData)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.createLivenessWithVerifySession(CreateLivenessSessionContent createLivenessSessionParameters, BinaryData verifyImage)"
|
||||
name: "createLivenessWithVerifySession(CreateLivenessSessionContent createLivenessSessionParameters, BinaryData verifyImage)"
|
||||
nameWithType: "FaceSessionClient.createLivenessWithVerifySession(CreateLivenessSessionContent createLivenessSessionParameters, BinaryData verifyImage)"
|
||||
summary: "Creates a new liveness session with an optional verification reference image."
|
||||
parameters:
|
||||
- description: "Request for creating liveness session."
|
||||
name: "createLivenessSessionParameters"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionContent?alt=com.azure.ai.vision.face.models.CreateLivenessSessionContent&text=CreateLivenessSessionContent\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "the content value of the verify image."
|
||||
name: "verifyImage"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public CreateLivenessWithVerifySessionResult createLivenessWithVerifySession(CreateLivenessSessionContent createLivenessSessionParameters, BinaryData verifyImage)"
|
||||
desc: "Creates a new liveness session with an optional verification reference image. This method is used to initiate a liveness session with the option to provide a verification image. If the verification image is provided, it will be used during verification process. Otherwise, the client device is expected to submit the verification image during the verification process. A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired. Permissions includes... > \\* \\* Ability to call /detectLivenessWithVerify/singleModal for up to 3 retries. \\* A token lifetime of 10 minutes. > \\[!NOTE\\] > > \\* > \\* Client access can be revoked by deleting the session using the Delete Liveness With Verify Session operation. > \\* To retrieve a result, use the Get Liveness With Verify Session. > \\* To audit the individual requests that a client has made to your resource, use the List Liveness With Verify Session Audit Entries. Alternative Option: Client device submits VerifyImage during the /detectLivenessWithVerify/singleModal call. > \\[!NOTE\\] > Extra measures should be taken to validate that the client is sending the expected VerifyImage."
|
||||
returns:
|
||||
description: "response of liveness session with verify creation with verify image provided."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult?alt=com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult&text=CreateLivenessWithVerifySessionResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.deleteLivenessSession(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.deleteLivenessSession(String sessionId)"
|
||||
name: "deleteLivenessSession(String sessionId)"
|
||||
nameWithType: "FaceSessionClient.deleteLivenessSession(String sessionId)"
|
||||
summary: "Delete all session related information for matching the specified session id."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public void deleteLivenessSession(String sessionId)"
|
||||
desc: "Delete all session related information for matching the specified session id. > \\[!NOTE\\] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused."
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.deleteLivenessSessionWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.deleteLivenessSessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "deleteLivenessSessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionClient.deleteLivenessSessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Delete all session related information for matching the specified session id."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<Void> deleteLivenessSessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Delete all session related information for matching the specified session id. > \\[!NOTE\\] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused."
|
||||
returns:
|
||||
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.deleteLivenessWithVerifySession(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.deleteLivenessWithVerifySession(String sessionId)"
|
||||
name: "deleteLivenessWithVerifySession(String sessionId)"
|
||||
nameWithType: "FaceSessionClient.deleteLivenessWithVerifySession(String sessionId)"
|
||||
summary: "Delete all session related information for matching the specified session id."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public void deleteLivenessWithVerifySession(String sessionId)"
|
||||
desc: "Delete all session related information for matching the specified session id. > \\[!NOTE\\] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused."
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.deleteLivenessWithVerifySessionWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.deleteLivenessWithVerifySessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "deleteLivenessWithVerifySessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionClient.deleteLivenessWithVerifySessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Delete all session related information for matching the specified session id."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<Void> deleteLivenessWithVerifySessionWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Delete all session related information for matching the specified session id. > \\[!NOTE\\] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any access for that token, those requests will still count towards overall resource rate limits. It's best to leverage TokenTTL to limit length of tokens in the case that it is misused."
|
||||
returns:
|
||||
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionAuditEntries(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionAuditEntries(String sessionId)"
|
||||
name: "getLivenessSessionAuditEntries(String sessionId)"
|
||||
nameWithType: "FaceSessionClient.getLivenessSessionAuditEntries(String sessionId)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public List<LivenessSessionAuditEntry> getLivenessSessionAuditEntries(String sessionId)"
|
||||
desc: "Gets session requests and response body for the session."
|
||||
returns:
|
||||
description: "session requests and response body for the session."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionAuditEntries(java.lang.String,java.lang.String,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
name: "getLivenessSessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
nameWithType: "FaceSessionClient.getLivenessSessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."
|
||||
name: "start"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The number of items to list, ranging in [1, 1000]. Default is 1000."
|
||||
name: "top"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public List<LivenessSessionAuditEntry> getLivenessSessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
desc: "Gets session requests and response body for the session."
|
||||
returns:
|
||||
description: "session requests and response body for the session."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionAuditEntriesWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "getLivenessSessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionClient.getLivenessSessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> getLivenessSessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Gets session requests and response body for the session.\n\n**Query Parameters**\n\n | ----- | ------- | -------- | -------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | start | String | No | List resources greater than the \"start\". It contains no more than 64 characters. Default is empty. |\n | top | Integer | No | The number of items to list, ranging in \\[1, 1000\\]. Default is 1000. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n id: long (Required)\n sessionId: String (Required)\n requestId: String (Required)\n clientRequestId: String (Required)\n receivedDateTime: OffsetDateTime (Required)\n request (Required): {\n url: String (Required)\n method: String (Required)\n contentLength: Long (Optional)\n contentType: String (Required)\n userAgent: String (Optional)\n }\n response (Required): {\n body (Required): {\n livenessDecision: String(uncertain/realface/spoofface) (Optional)\n target (Optional): {\n faceRectangle (Required): {\n top: int (Required)\n left: int (Required)\n width: int (Required)\n height: int (Required)\n }\n fileName: String (Required)\n timeOffsetWithinFile: int (Required)\n imageType: String(Color/Infrared/Depth) (Required)\n }\n modelVersionUsed: String(2020-02-15-preview.01/2021-11-12-preview.03/2022-10-15-preview.04/2023-03-02-preview.05) (Optional)\n verifyResult (Optional): {\n verifyImage (Required): {\n faceRectangle (Required): (recursive schema, see faceRectangle above)\n qualityForRecognition: String(low/medium/high) (Required)\n }\n matchConfidence: double (Required)\n isIdentical: boolean (Required)\n }\n (Optional): {\n String: Object (Required)\n }\n }\n statusCode: int (Required)\n latencyInMilliseconds: long (Required)\n }\n digest: String (Required)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "session requests and response body for the session along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionResult(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionResult(String sessionId)"
|
||||
name: "getLivenessSessionResult(String sessionId)"
|
||||
nameWithType: "FaceSessionClient.getLivenessSessionResult(String sessionId)"
|
||||
summary: "Get session result of detect<wbr>Liveness/single<wbr>Modal call."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public LivenessSession getLivenessSessionResult(String sessionId)"
|
||||
desc: "Get session result of detectLiveness/singleModal call."
|
||||
returns:
|
||||
description: "session result of detectLiveness/singleModal call."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessSession?alt=com.azure.ai.vision.face.models.LivenessSession&text=LivenessSession\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionResultWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "getLivenessSessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionClient.getLivenessSessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Get session result of detect<wbr>Liveness/single<wbr>Modal call."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> getLivenessSessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Get session result of detectLiveness/singleModal call.\n\n**Response Body Schema**\n\n```java\n{\n id: String (Required)\n createdDateTime: OffsetDateTime (Required)\n sessionStartDateTime: OffsetDateTime (Optional)\n sessionExpired: boolean (Required)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n status: String(NotStarted/Started/ResultAvailable) (Required)\n result (Optional): {\n id: long (Required)\n sessionId: String (Required)\n requestId: String (Required)\n clientRequestId: String (Required)\n receivedDateTime: OffsetDateTime (Required)\n request (Required): {\n url: String (Required)\n method: String (Required)\n contentLength: Long (Optional)\n contentType: String (Required)\n userAgent: String (Optional)\n }\n response (Required): {\n body (Required): {\n livenessDecision: String(uncertain/realface/spoofface) (Optional)\n target (Optional): {\n faceRectangle (Required): {\n top: int (Required)\n left: int (Required)\n width: int (Required)\n height: int (Required)\n }\n fileName: String (Required)\n timeOffsetWithinFile: int (Required)\n imageType: String(Color/Infrared/Depth) (Required)\n }\n modelVersionUsed: String(2020-02-15-preview.01/2021-11-12-preview.03/2022-10-15-preview.04/2023-03-02-preview.05) (Optional)\n verifyResult (Optional): {\n verifyImage (Required): {\n faceRectangle (Required): (recursive schema, see faceRectangle above)\n qualityForRecognition: String(low/medium/high) (Required)\n }\n matchConfidence: double (Required)\n isIdentical: boolean (Required)\n }\n (Optional): {\n String: Object (Required)\n }\n }\n statusCode: int (Required)\n latencyInMilliseconds: long (Required)\n }\n digest: String (Required)\n }\n }\n```"
|
||||
returns:
|
||||
description: "session result of detectLiveness/singleModal call along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessions()"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessions()"
|
||||
name: "getLivenessSessions()"
|
||||
nameWithType: "FaceSessionClient.getLivenessSessions()"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness/Single<wbr>Modal."
|
||||
syntax: "public List<LivenessSessionItem> getLivenessSessions()"
|
||||
desc: "Lists sessions for /detectLiveness/SingleModal. List sessions from the last sessionId greater than the 'start'. The result should be ordered by sessionId in ascending order."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionItem?alt=com.azure.ai.vision.face.models.LivenessSessionItem&text=LivenessSessionItem\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessions(java.lang.String,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessions(String start, Integer top)"
|
||||
name: "getLivenessSessions(String start, Integer top)"
|
||||
nameWithType: "FaceSessionClient.getLivenessSessions(String start, Integer top)"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness/Single<wbr>Modal."
|
||||
parameters:
|
||||
- description: "List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."
|
||||
name: "start"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The number of items to list, ranging in [1, 1000]. Default is 1000."
|
||||
name: "top"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public List<LivenessSessionItem> getLivenessSessions(String start, Integer top)"
|
||||
desc: "Lists sessions for /detectLiveness/SingleModal. List sessions from the last sessionId greater than the 'start'. The result should be ordered by sessionId in ascending order."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionItem?alt=com.azure.ai.vision.face.models.LivenessSessionItem&text=LivenessSessionItem\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionsWithResponse(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessSessionsWithResponse(RequestOptions requestOptions)"
|
||||
name: "getLivenessSessionsWithResponse(RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionClient.getLivenessSessionsWithResponse(RequestOptions requestOptions)"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness/Single<wbr>Modal."
|
||||
parameters:
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> getLivenessSessionsWithResponse(RequestOptions requestOptions)"
|
||||
desc: "Lists sessions for /detectLiveness/SingleModal. List sessions from the last sessionId greater than the 'start'. The result should be ordered by sessionId in ascending order.\n\n**Query Parameters**\n\n | ----- | ------- | -------- | -------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | start | String | No | List resources greater than the \"start\". It contains no more than 64 characters. Default is empty. |\n | top | Integer | No | The number of items to list, ranging in \\[1, 1000\\]. Default is 1000. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n id: String (Required)\n createdDateTime: OffsetDateTime (Required)\n sessionStartDateTime: OffsetDateTime (Optional)\n sessionExpired: boolean (Required)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "the response body along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionAuditEntries(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionAuditEntries(String sessionId)"
|
||||
name: "getLivenessWithVerifySessionAuditEntries(String sessionId)"
|
||||
nameWithType: "FaceSessionClient.getLivenessWithVerifySessionAuditEntries(String sessionId)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public List<LivenessSessionAuditEntry> getLivenessWithVerifySessionAuditEntries(String sessionId)"
|
||||
desc: "Gets session requests and response body for the session."
|
||||
returns:
|
||||
description: "session requests and response body for the session."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionAuditEntries(java.lang.String,java.lang.String,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
name: "getLivenessWithVerifySessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
nameWithType: "FaceSessionClient.getLivenessWithVerifySessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."
|
||||
name: "start"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The number of items to list, ranging in [1, 1000]. Default is 1000."
|
||||
name: "top"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public List<LivenessSessionAuditEntry> getLivenessWithVerifySessionAuditEntries(String sessionId, String start, Integer top)"
|
||||
desc: "Gets session requests and response body for the session."
|
||||
returns:
|
||||
description: "session requests and response body for the session."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionAuditEntriesWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "getLivenessWithVerifySessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionClient.getLivenessWithVerifySessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Gets session requests and response body for the session."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> getLivenessWithVerifySessionAuditEntriesWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Gets session requests and response body for the session.\n\n**Query Parameters**\n\n | ----- | ------- | -------- | -------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | start | String | No | List resources greater than the \"start\". It contains no more than 64 characters. Default is empty. |\n | top | Integer | No | The number of items to list, ranging in \\[1, 1000\\]. Default is 1000. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n id: long (Required)\n sessionId: String (Required)\n requestId: String (Required)\n clientRequestId: String (Required)\n receivedDateTime: OffsetDateTime (Required)\n request (Required): {\n url: String (Required)\n method: String (Required)\n contentLength: Long (Optional)\n contentType: String (Required)\n userAgent: String (Optional)\n }\n response (Required): {\n body (Required): {\n livenessDecision: String(uncertain/realface/spoofface) (Optional)\n target (Optional): {\n faceRectangle (Required): {\n top: int (Required)\n left: int (Required)\n width: int (Required)\n height: int (Required)\n }\n fileName: String (Required)\n timeOffsetWithinFile: int (Required)\n imageType: String(Color/Infrared/Depth) (Required)\n }\n modelVersionUsed: String(2020-02-15-preview.01/2021-11-12-preview.03/2022-10-15-preview.04/2023-03-02-preview.05) (Optional)\n verifyResult (Optional): {\n verifyImage (Required): {\n faceRectangle (Required): (recursive schema, see faceRectangle above)\n qualityForRecognition: String(low/medium/high) (Required)\n }\n matchConfidence: double (Required)\n isIdentical: boolean (Required)\n }\n (Optional): {\n String: Object (Required)\n }\n }\n statusCode: int (Required)\n latencyInMilliseconds: long (Required)\n }\n digest: String (Required)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "session requests and response body for the session along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionResult(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionResult(String sessionId)"
|
||||
name: "getLivenessWithVerifySessionResult(String sessionId)"
|
||||
nameWithType: "FaceSessionClient.getLivenessWithVerifySessionResult(String sessionId)"
|
||||
summary: "Get session result of detect<wbr>Liveness<wbr>With<wbr>Verify/single<wbr>Modal call."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public LivenessWithVerifySession getLivenessWithVerifySessionResult(String sessionId)"
|
||||
desc: "Get session result of detectLivenessWithVerify/singleModal call."
|
||||
returns:
|
||||
description: "session result of detectLivenessWithVerify/singleModal call."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessWithVerifySession?alt=com.azure.ai.vision.face.models.LivenessWithVerifySession&text=LivenessWithVerifySession\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionResultWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
name: "getLivenessWithVerifySessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionClient.getLivenessWithVerifySessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
summary: "Get session result of detect<wbr>Liveness<wbr>With<wbr>Verify/single<wbr>Modal call."
|
||||
parameters:
|
||||
- description: "The unique ID to reference this session."
|
||||
name: "sessionId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> getLivenessWithVerifySessionResultWithResponse(String sessionId, RequestOptions requestOptions)"
|
||||
desc: "Get session result of detectLivenessWithVerify/singleModal call.\n\n**Response Body Schema**\n\n```java\n{\n id: String (Required)\n createdDateTime: OffsetDateTime (Required)\n sessionStartDateTime: OffsetDateTime (Optional)\n sessionExpired: boolean (Required)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n status: String(NotStarted/Started/ResultAvailable) (Required)\n result (Optional): {\n id: long (Required)\n sessionId: String (Required)\n requestId: String (Required)\n clientRequestId: String (Required)\n receivedDateTime: OffsetDateTime (Required)\n request (Required): {\n url: String (Required)\n method: String (Required)\n contentLength: Long (Optional)\n contentType: String (Required)\n userAgent: String (Optional)\n }\n response (Required): {\n body (Required): {\n livenessDecision: String(uncertain/realface/spoofface) (Optional)\n target (Optional): {\n faceRectangle (Required): {\n top: int (Required)\n left: int (Required)\n width: int (Required)\n height: int (Required)\n }\n fileName: String (Required)\n timeOffsetWithinFile: int (Required)\n imageType: String(Color/Infrared/Depth) (Required)\n }\n modelVersionUsed: String(2020-02-15-preview.01/2021-11-12-preview.03/2022-10-15-preview.04/2023-03-02-preview.05) (Optional)\n verifyResult (Optional): {\n verifyImage (Required): {\n faceRectangle (Required): (recursive schema, see faceRectangle above)\n qualityForRecognition: String(low/medium/high) (Required)\n }\n matchConfidence: double (Required)\n isIdentical: boolean (Required)\n }\n (Optional): {\n String: Object (Required)\n }\n }\n statusCode: int (Required)\n latencyInMilliseconds: long (Required)\n }\n digest: String (Required)\n }\n }\n```"
|
||||
returns:
|
||||
description: "session result of detectLivenessWithVerify/singleModal call along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessions()"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessions()"
|
||||
name: "getLivenessWithVerifySessions()"
|
||||
nameWithType: "FaceSessionClient.getLivenessWithVerifySessions()"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness<wbr>With<wbr>Verify/Single<wbr>Modal."
|
||||
syntax: "public List<LivenessSessionItem> getLivenessWithVerifySessions()"
|
||||
desc: "Lists sessions for /detectLivenessWithVerify/SingleModal. List sessions from the last sessionId greater than the \"start\". The result should be ordered by sessionId in ascending order."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionItem?alt=com.azure.ai.vision.face.models.LivenessSessionItem&text=LivenessSessionItem\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessions(java.lang.String,java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessions(String start, Integer top)"
|
||||
name: "getLivenessWithVerifySessions(String start, Integer top)"
|
||||
nameWithType: "FaceSessionClient.getLivenessWithVerifySessions(String start, Integer top)"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness<wbr>With<wbr>Verify/Single<wbr>Modal."
|
||||
parameters:
|
||||
- description: "List resources greater than the \"start\". It contains no more than 64 characters. Default is empty."
|
||||
name: "start"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The number of items to list, ranging in [1, 1000]. Default is 1000."
|
||||
name: "top"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public List<LivenessSessionItem> getLivenessWithVerifySessions(String start, Integer top)"
|
||||
desc: "Lists sessions for /detectLivenessWithVerify/SingleModal. List sessions from the last sessionId greater than the \"start\". The result should be ordered by sessionId in ascending order."
|
||||
returns:
|
||||
description: "the response."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.LivenessSessionItem?alt=com.azure.ai.vision.face.models.LivenessSessionItem&text=LivenessSessionItem\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionsWithResponse(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClient.getLivenessWithVerifySessionsWithResponse(RequestOptions requestOptions)"
|
||||
name: "getLivenessWithVerifySessionsWithResponse(RequestOptions requestOptions)"
|
||||
nameWithType: "FaceSessionClient.getLivenessWithVerifySessionsWithResponse(RequestOptions requestOptions)"
|
||||
summary: "Lists sessions for /detect<wbr>Liveness<wbr>With<wbr>Verify/Single<wbr>Modal."
|
||||
parameters:
|
||||
- description: "The options to configure the HTTP request before HTTP client sends it."
|
||||
name: "requestOptions"
|
||||
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Response<BinaryData> getLivenessWithVerifySessionsWithResponse(RequestOptions requestOptions)"
|
||||
desc: "Lists sessions for /detectLivenessWithVerify/SingleModal. List sessions from the last sessionId greater than the \"start\". The result should be ordered by sessionId in ascending order.\n\n**Query Parameters**\n\n | ----- | ------- | -------- | -------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | start | String | No | List resources greater than the \"start\". It contains no more than 64 characters. Default is empty. |\n | top | Integer | No | The number of items to list, ranging in \\[1, 1000\\]. Default is 1000. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n[\n (Required){\n id: String (Required)\n createdDateTime: OffsetDateTime (Required)\n sessionStartDateTime: OffsetDateTime (Optional)\n sessionExpired: boolean (Required)\n deviceCorrelationId: String (Optional)\n authTokenTimeToLiveInSeconds: Integer (Optional)\n }\n ]\n```"
|
||||
returns:
|
||||
description: "the response body along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Initializes a new instance of the synchronous FaceSessionClient type."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,211 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.FaceSessionClientBuilder"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder"
|
||||
name: "FaceSessionClientBuilder"
|
||||
nameWithType: "FaceSessionClientBuilder"
|
||||
summary: "A builder for creating a new instance of the Face<wbr>Session<wbr>Client type."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceSessionClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.FaceSessionClientBuilder()"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.FaceSessionClientBuilder()"
|
||||
name: "FaceSessionClientBuilder()"
|
||||
nameWithType: "FaceSessionClientBuilder.FaceSessionClientBuilder()"
|
||||
summary: "Create an instance of the Face<wbr>Session<wbr>Client<wbr>Builder."
|
||||
syntax: "public FaceSessionClientBuilder()"
|
||||
desc: "Create an instance of the FaceSessionClientBuilder."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
nameWithType: "FaceSessionClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "customPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.buildAsyncClient()"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.buildAsyncClient()"
|
||||
name: "buildAsyncClient()"
|
||||
nameWithType: "FaceSessionClientBuilder.buildAsyncClient()"
|
||||
summary: "Builds an instance of Face<wbr>Session<wbr>Async<wbr>Client class."
|
||||
syntax: "public FaceSessionAsyncClient buildAsyncClient()"
|
||||
desc: "Builds an instance of FaceSessionAsyncClient class."
|
||||
returns:
|
||||
description: "an instance of FaceSessionAsyncClient."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionAsyncClient?alt=com.azure.ai.vision.face.FaceSessionAsyncClient&text=FaceSessionAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.buildClient()"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.buildClient()"
|
||||
name: "buildClient()"
|
||||
nameWithType: "FaceSessionClientBuilder.buildClient()"
|
||||
summary: "Builds an instance of Face<wbr>Session<wbr>Client class."
|
||||
syntax: "public FaceSessionClient buildClient()"
|
||||
desc: "Builds an instance of FaceSessionClient class."
|
||||
returns:
|
||||
description: "an instance of FaceSessionClient."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClient?alt=com.azure.ai.vision.face.FaceSessionClient&text=FaceSessionClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
name: "clientOptions(ClientOptions clientOptions)"
|
||||
nameWithType: "FaceSessionClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "clientOptions"
|
||||
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder clientOptions(ClientOptions clientOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.configuration(Configuration configuration)"
|
||||
name: "configuration(Configuration configuration)"
|
||||
nameWithType: "FaceSessionClientBuilder.configuration(Configuration configuration)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "configuration"
|
||||
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder configuration(Configuration configuration)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.credential(com.azure.core.credential.KeyCredential)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.credential(KeyCredential keyCredential)"
|
||||
name: "credential(KeyCredential keyCredential)"
|
||||
nameWithType: "FaceSessionClientBuilder.credential(KeyCredential keyCredential)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "keyCredential"
|
||||
type: "<xref href=\"com.azure.core.credential.KeyCredential?alt=com.azure.core.credential.KeyCredential&text=KeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder credential(KeyCredential keyCredential)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
name: "credential(TokenCredential tokenCredential)"
|
||||
nameWithType: "FaceSessionClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "tokenCredential"
|
||||
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder credential(TokenCredential tokenCredential)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.endpoint(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.endpoint(String endpoint)"
|
||||
name: "endpoint(String endpoint)"
|
||||
nameWithType: "FaceSessionClientBuilder.endpoint(String endpoint)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "endpoint"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public FaceSessionClientBuilder endpoint(String endpoint)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.httpClient(HttpClient httpClient)"
|
||||
name: "httpClient(HttpClient httpClient)"
|
||||
nameWithType: "FaceSessionClientBuilder.httpClient(HttpClient httpClient)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpClient"
|
||||
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder httpClient(HttpClient httpClient)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
nameWithType: "FaceSessionClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpLogOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
name: "pipeline(HttpPipeline pipeline)"
|
||||
nameWithType: "FaceSessionClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "pipeline"
|
||||
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder pipeline(HttpPipeline pipeline)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
name: "retryOptions(RetryOptions retryOptions)"
|
||||
nameWithType: "FaceSessionClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "retryOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder retryOptions(RetryOptions retryOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
name: "retryPolicy(RetryPolicy retryPolicy)"
|
||||
nameWithType: "FaceSessionClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
summary: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
parameters:
|
||||
- description: "the retryPolicy value."
|
||||
name: "retryPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryPolicy?alt=com.azure.core.http.policy.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
||||
desc: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
returns:
|
||||
description: "the FaceSessionClientBuilder."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.FaceSessionClientBuilder.serviceVersion(com.azure.ai.vision.face.FaceServiceVersion)"
|
||||
fullName: "com.azure.ai.vision.face.FaceSessionClientBuilder.serviceVersion(FaceServiceVersion serviceVersion)"
|
||||
name: "serviceVersion(FaceServiceVersion serviceVersion)"
|
||||
nameWithType: "FaceSessionClientBuilder.serviceVersion(FaceServiceVersion serviceVersion)"
|
||||
summary: "Sets Service version."
|
||||
parameters:
|
||||
- description: "the serviceVersion value."
|
||||
name: "serviceVersion"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceServiceVersion?alt=com.azure.ai.vision.face.FaceServiceVersion&text=FaceServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FaceSessionClientBuilder serviceVersion(FaceServiceVersion serviceVersion)"
|
||||
desc: "Sets Service version."
|
||||
returns:
|
||||
description: "the FaceSessionClientBuilder."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A builder for creating a new instance of the FaceSessionClient type."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.FaceSessionClientBuilder?alt=com.azure.ai.vision.face.FaceSessionClientBuilder&text=FaceSessionClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.AccessoryItem"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryItem"
|
||||
name: "AccessoryItem"
|
||||
nameWithType: "AccessoryItem"
|
||||
summary: "Accessory item and corresponding confidence level."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **AccessoryItem**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.AccessoryItem.getConfidence()"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryItem.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "AccessoryItem.getConfidence()"
|
||||
summary: "Get the confidence property: Confidence level of the accessory type."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: Confidence level of the accessory type. Range between \\[0,1\\]."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.AccessoryItem.getType()"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryItem.getType()"
|
||||
name: "getType()"
|
||||
nameWithType: "AccessoryItem.getType()"
|
||||
summary: "Get the type property: Type of the accessory."
|
||||
syntax: "public AccessoryType getType()"
|
||||
desc: "Get the type property: Type of the accessory."
|
||||
returns:
|
||||
description: "the type value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.AccessoryType?alt=com.azure.ai.vision.face.models.AccessoryType&text=AccessoryType\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Accessory item and corresponding confidence level."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.AccessoryType"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryType"
|
||||
name: "AccessoryType"
|
||||
nameWithType: "AccessoryType"
|
||||
summary: "Type of the accessory."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **AccessoryType**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.AccessoryType?alt=com.azure.ai.vision.face.models.AccessoryType&text=AccessoryType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.AccessoryType.AccessoryType()"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryType.AccessoryType()"
|
||||
name: "AccessoryType()"
|
||||
nameWithType: "AccessoryType.AccessoryType()"
|
||||
summary: "Creates a new instance of Accessory<wbr>Type value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.AccessoryType.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public AccessoryType()"
|
||||
desc: "Creates a new instance of AccessoryType value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.AccessoryType.GLASSES"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryType.GLASSES"
|
||||
name: "GLASSES"
|
||||
nameWithType: "AccessoryType.GLASSES"
|
||||
summary: "Glasses."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.AccessoryType?alt=com.azure.ai.vision.face.models.AccessoryType&text=AccessoryType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final AccessoryType GLASSES"
|
||||
desc: "Glasses."
|
||||
- uid: "com.azure.ai.vision.face.models.AccessoryType.HEADWEAR"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryType.HEADWEAR"
|
||||
name: "HEADWEAR"
|
||||
nameWithType: "AccessoryType.HEADWEAR"
|
||||
summary: "Head wear."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.AccessoryType?alt=com.azure.ai.vision.face.models.AccessoryType&text=AccessoryType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final AccessoryType HEADWEAR"
|
||||
desc: "Head wear."
|
||||
- uid: "com.azure.ai.vision.face.models.AccessoryType.MASK"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryType.MASK"
|
||||
name: "MASK"
|
||||
nameWithType: "AccessoryType.MASK"
|
||||
summary: "Mask."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.AccessoryType?alt=com.azure.ai.vision.face.models.AccessoryType&text=AccessoryType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final AccessoryType MASK"
|
||||
desc: "Mask."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.AccessoryType.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryType.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "AccessoryType.fromString(String name)"
|
||||
summary: "Creates or finds a Accessory<wbr>Type from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static AccessoryType fromString(String name)"
|
||||
desc: "Creates or finds a AccessoryType from its string representation."
|
||||
returns:
|
||||
description: "the corresponding AccessoryType."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.AccessoryType?alt=com.azure.ai.vision.face.models.AccessoryType&text=AccessoryType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.AccessoryType.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.AccessoryType.values()"
|
||||
name: "values()"
|
||||
nameWithType: "AccessoryType.values()"
|
||||
summary: "Gets known Accessory<wbr>Type values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<AccessoryType> values()"
|
||||
desc: "Gets known AccessoryType values."
|
||||
returns:
|
||||
description: "known AccessoryType values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.AccessoryType?alt=com.azure.ai.vision.face.models.AccessoryType&text=AccessoryType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Type of the accessory."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.AuditLivenessResponseInfo"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditLivenessResponseInfo"
|
||||
name: "AuditLivenessResponseInfo"
|
||||
nameWithType: "AuditLivenessResponseInfo"
|
||||
summary: "Audit entry for a response in the session."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **AuditLivenessResponseInfo**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.AuditLivenessResponseInfo.getBody()"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditLivenessResponseInfo.getBody()"
|
||||
name: "getBody()"
|
||||
nameWithType: "AuditLivenessResponseInfo.getBody()"
|
||||
summary: "Get the body property: The response body."
|
||||
syntax: "public LivenessResponseBody getBody()"
|
||||
desc: "Get the body property: The response body. The schema of this field will depend on the request.url and request.method used by the client."
|
||||
returns:
|
||||
description: "the body value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessResponseBody?alt=com.azure.ai.vision.face.models.LivenessResponseBody&text=LivenessResponseBody\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.AuditLivenessResponseInfo.getLatencyInMilliseconds()"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditLivenessResponseInfo.getLatencyInMilliseconds()"
|
||||
name: "getLatencyInMilliseconds()"
|
||||
nameWithType: "AuditLivenessResponseInfo.getLatencyInMilliseconds()"
|
||||
summary: "Get the latency<wbr>InMilliseconds property: The server measured latency for this request in milliseconds."
|
||||
syntax: "public long getLatencyInMilliseconds()"
|
||||
desc: "Get the latencyInMilliseconds property: The server measured latency for this request in milliseconds."
|
||||
returns:
|
||||
description: "the latencyInMilliseconds value."
|
||||
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.AuditLivenessResponseInfo.getStatusCode()"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditLivenessResponseInfo.getStatusCode()"
|
||||
name: "getStatusCode()"
|
||||
nameWithType: "AuditLivenessResponseInfo.getStatusCode()"
|
||||
summary: "Get the status<wbr>Code property: The HTTP status code returned to the client."
|
||||
syntax: "public int getStatusCode()"
|
||||
desc: "Get the statusCode property: The HTTP status code returned to the client."
|
||||
returns:
|
||||
description: "the statusCode value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Audit entry for a response in the session."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.AuditRequestInfo"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditRequestInfo"
|
||||
name: "AuditRequestInfo"
|
||||
nameWithType: "AuditRequestInfo"
|
||||
summary: "Audit entry for a request in the session."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **AuditRequestInfo**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.AuditRequestInfo.getContentLength()"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditRequestInfo.getContentLength()"
|
||||
name: "getContentLength()"
|
||||
nameWithType: "AuditRequestInfo.getContentLength()"
|
||||
summary: "Get the content<wbr>Length property: The length of the request body in bytes."
|
||||
syntax: "public Long getContentLength()"
|
||||
desc: "Get the contentLength property: The length of the request body in bytes."
|
||||
returns:
|
||||
description: "the contentLength value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.AuditRequestInfo.getContentType()"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditRequestInfo.getContentType()"
|
||||
name: "getContentType()"
|
||||
nameWithType: "AuditRequestInfo.getContentType()"
|
||||
summary: "Get the content<wbr>Type property: The content type of the request."
|
||||
syntax: "public String getContentType()"
|
||||
desc: "Get the contentType property: The content type of the request."
|
||||
returns:
|
||||
description: "the contentType value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.AuditRequestInfo.getMethod()"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditRequestInfo.getMethod()"
|
||||
name: "getMethod()"
|
||||
nameWithType: "AuditRequestInfo.getMethod()"
|
||||
summary: "Get the method property: The HTTP method of the request (i.<wbr>e., GET, POST, DELETE)."
|
||||
syntax: "public String getMethod()"
|
||||
desc: "Get the method property: The HTTP method of the request (i.e., GET, POST, DELETE)."
|
||||
returns:
|
||||
description: "the method value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.AuditRequestInfo.getUrl()"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditRequestInfo.getUrl()"
|
||||
name: "getUrl()"
|
||||
nameWithType: "AuditRequestInfo.getUrl()"
|
||||
summary: "Get the url property: The relative URL and query of the liveness request."
|
||||
syntax: "public String getUrl()"
|
||||
desc: "Get the url property: The relative URL and query of the liveness request."
|
||||
returns:
|
||||
description: "the url value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.AuditRequestInfo.getUserAgent()"
|
||||
fullName: "com.azure.ai.vision.face.models.AuditRequestInfo.getUserAgent()"
|
||||
name: "getUserAgent()"
|
||||
nameWithType: "AuditRequestInfo.getUserAgent()"
|
||||
summary: "Get the user<wbr>Agent property: The user agent used to submit the request."
|
||||
syntax: "public String getUserAgent()"
|
||||
desc: "Get the userAgent property: The user agent used to submit the request."
|
||||
returns:
|
||||
description: "the userAgent value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Audit entry for a request in the session."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.BlurLevel"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurLevel"
|
||||
name: "BlurLevel"
|
||||
nameWithType: "BlurLevel"
|
||||
summary: "Indicates level of blurriness."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **BlurLevel**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.BlurLevel?alt=com.azure.ai.vision.face.models.BlurLevel&text=BlurLevel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.BlurLevel.BlurLevel()"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurLevel.BlurLevel()"
|
||||
name: "BlurLevel()"
|
||||
nameWithType: "BlurLevel.BlurLevel()"
|
||||
summary: "Creates a new instance of Blur<wbr>Level value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.BlurLevel.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public BlurLevel()"
|
||||
desc: "Creates a new instance of BlurLevel value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.BlurLevel.HIGH"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurLevel.HIGH"
|
||||
name: "HIGH"
|
||||
nameWithType: "BlurLevel.HIGH"
|
||||
summary: "High blur level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.BlurLevel?alt=com.azure.ai.vision.face.models.BlurLevel&text=BlurLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final BlurLevel HIGH"
|
||||
desc: "High blur level."
|
||||
- uid: "com.azure.ai.vision.face.models.BlurLevel.LOW"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurLevel.LOW"
|
||||
name: "LOW"
|
||||
nameWithType: "BlurLevel.LOW"
|
||||
summary: "Low blur level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.BlurLevel?alt=com.azure.ai.vision.face.models.BlurLevel&text=BlurLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final BlurLevel LOW"
|
||||
desc: "Low blur level."
|
||||
- uid: "com.azure.ai.vision.face.models.BlurLevel.MEDIUM"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurLevel.MEDIUM"
|
||||
name: "MEDIUM"
|
||||
nameWithType: "BlurLevel.MEDIUM"
|
||||
summary: "Medium blur level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.BlurLevel?alt=com.azure.ai.vision.face.models.BlurLevel&text=BlurLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final BlurLevel MEDIUM"
|
||||
desc: "Medium blur level."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.BlurLevel.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurLevel.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "BlurLevel.fromString(String name)"
|
||||
summary: "Creates or finds a Blur<wbr>Level from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static BlurLevel fromString(String name)"
|
||||
desc: "Creates or finds a BlurLevel from its string representation."
|
||||
returns:
|
||||
description: "the corresponding BlurLevel."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.BlurLevel?alt=com.azure.ai.vision.face.models.BlurLevel&text=BlurLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.BlurLevel.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurLevel.values()"
|
||||
name: "values()"
|
||||
nameWithType: "BlurLevel.values()"
|
||||
summary: "Gets known Blur<wbr>Level values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<BlurLevel> values()"
|
||||
desc: "Gets known BlurLevel values."
|
||||
returns:
|
||||
description: "known BlurLevel values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.BlurLevel?alt=com.azure.ai.vision.face.models.BlurLevel&text=BlurLevel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Indicates level of blurriness."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.BlurProperties"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurProperties"
|
||||
name: "BlurProperties"
|
||||
nameWithType: "BlurProperties"
|
||||
summary: "Properties describing any presence of blur within the image."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **BlurProperties**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.BlurProperties.getBlurLevel()"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurProperties.getBlurLevel()"
|
||||
name: "getBlurLevel()"
|
||||
nameWithType: "BlurProperties.getBlurLevel()"
|
||||
summary: "Get the blur<wbr>Level property: An enum value indicating level of blurriness."
|
||||
syntax: "public BlurLevel getBlurLevel()"
|
||||
desc: "Get the blurLevel property: An enum value indicating level of blurriness."
|
||||
returns:
|
||||
description: "the blurLevel value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.BlurLevel?alt=com.azure.ai.vision.face.models.BlurLevel&text=BlurLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.BlurProperties.getValue()"
|
||||
fullName: "com.azure.ai.vision.face.models.BlurProperties.getValue()"
|
||||
name: "getValue()"
|
||||
nameWithType: "BlurProperties.getValue()"
|
||||
summary: "Get the value property: A number indicating level of blurriness ranging from 0 to 1."
|
||||
syntax: "public double getValue()"
|
||||
desc: "Get the value property: A number indicating level of blurriness ranging from 0 to 1."
|
||||
returns:
|
||||
description: "the value value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Properties describing any presence of blur within the image."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,147 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent"
|
||||
name: "CreateLivenessSessionContent"
|
||||
nameWithType: "CreateLivenessSessionContent"
|
||||
summary: "Request for creating liveness session."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **CreateLivenessSessionContent**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.CreateLivenessSessionContent(com.azure.ai.vision.face.models.LivenessOperationMode)"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.CreateLivenessSessionContent(LivenessOperationMode livenessOperationMode)"
|
||||
name: "CreateLivenessSessionContent(LivenessOperationMode livenessOperationMode)"
|
||||
nameWithType: "CreateLivenessSessionContent.CreateLivenessSessionContent(LivenessOperationMode livenessOperationMode)"
|
||||
summary: "Creates an instance of Create<wbr>Liveness<wbr>Session<wbr>Content class."
|
||||
parameters:
|
||||
- description: "the livenessOperationMode value to set."
|
||||
name: "livenessOperationMode"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessOperationMode?alt=com.azure.ai.vision.face.models.LivenessOperationMode&text=LivenessOperationMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public CreateLivenessSessionContent(LivenessOperationMode livenessOperationMode)"
|
||||
desc: "Creates an instance of CreateLivenessSessionContent class."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.getAuthTokenTimeToLiveInSeconds()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.getAuthTokenTimeToLiveInSeconds()"
|
||||
name: "getAuthTokenTimeToLiveInSeconds()"
|
||||
nameWithType: "CreateLivenessSessionContent.getAuthTokenTimeToLiveInSeconds()"
|
||||
summary: "Get the auth<wbr>Token<wbr>Time<wbr>ToLive<wbr>InSeconds property: Seconds the session should last for."
|
||||
syntax: "public Integer getAuthTokenTimeToLiveInSeconds()"
|
||||
desc: "Get the authTokenTimeToLiveInSeconds property: Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600."
|
||||
returns:
|
||||
description: "the authTokenTimeToLiveInSeconds value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.getDeviceCorrelationId()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.getDeviceCorrelationId()"
|
||||
name: "getDeviceCorrelationId()"
|
||||
nameWithType: "CreateLivenessSessionContent.getDeviceCorrelationId()"
|
||||
summary: "Get the device<wbr>Correlation<wbr>Id property: Unique Guid per each end-user device."
|
||||
syntax: "public String getDeviceCorrelationId()"
|
||||
desc: "Get the deviceCorrelationId property: Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null."
|
||||
returns:
|
||||
description: "the deviceCorrelationId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.getLivenessOperationMode()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.getLivenessOperationMode()"
|
||||
name: "getLivenessOperationMode()"
|
||||
nameWithType: "CreateLivenessSessionContent.getLivenessOperationMode()"
|
||||
summary: "Get the liveness<wbr>Operation<wbr>Mode property: Type of liveness mode the client should follow."
|
||||
syntax: "public LivenessOperationMode getLivenessOperationMode()"
|
||||
desc: "Get the livenessOperationMode property: Type of liveness mode the client should follow."
|
||||
returns:
|
||||
description: "the livenessOperationMode value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessOperationMode?alt=com.azure.ai.vision.face.models.LivenessOperationMode&text=LivenessOperationMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.isDeviceCorrelationIdSetInClient()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.isDeviceCorrelationIdSetInClient()"
|
||||
name: "isDeviceCorrelationIdSetInClient()"
|
||||
nameWithType: "CreateLivenessSessionContent.isDeviceCorrelationIdSetInClient()"
|
||||
summary: "Get the device<wbr>Correlation<wbr>IdSet<wbr>InClient property: Whether or not to allow client to set their own 'device<wbr>Correlation<wbr>Id' via the Vision SDK."
|
||||
syntax: "public Boolean isDeviceCorrelationIdSetInClient()"
|
||||
desc: "Get the deviceCorrelationIdSetInClient property: Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body."
|
||||
returns:
|
||||
description: "the deviceCorrelationIdSetInClient value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.isSendResultsToClient()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.isSendResultsToClient()"
|
||||
name: "isSendResultsToClient()"
|
||||
nameWithType: "CreateLivenessSessionContent.isSendResultsToClient()"
|
||||
summary: "Get the send<wbr>Results<wbr>ToClient property: Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons."
|
||||
syntax: "public Boolean isSendResultsToClient()"
|
||||
desc: "Get the sendResultsToClient property: Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons. Default is false, clients will receive a '204 - NoContent' empty body response. Regardless of selection, calling Session GetResult will always contain a response body enabling business logic to be implemented."
|
||||
returns:
|
||||
description: "the sendResultsToClient value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.setAuthTokenTimeToLiveInSeconds(java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.setAuthTokenTimeToLiveInSeconds(Integer authTokenTimeToLiveInSeconds)"
|
||||
name: "setAuthTokenTimeToLiveInSeconds(Integer authTokenTimeToLiveInSeconds)"
|
||||
nameWithType: "CreateLivenessSessionContent.setAuthTokenTimeToLiveInSeconds(Integer authTokenTimeToLiveInSeconds)"
|
||||
summary: "Set the auth<wbr>Token<wbr>Time<wbr>ToLive<wbr>InSeconds property: Seconds the session should last for."
|
||||
parameters:
|
||||
- description: "the authTokenTimeToLiveInSeconds value to set."
|
||||
name: "authTokenTimeToLiveInSeconds"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public CreateLivenessSessionContent setAuthTokenTimeToLiveInSeconds(Integer authTokenTimeToLiveInSeconds)"
|
||||
desc: "Set the authTokenTimeToLiveInSeconds property: Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600."
|
||||
returns:
|
||||
description: "the CreateLivenessSessionContent object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionContent?alt=com.azure.ai.vision.face.models.CreateLivenessSessionContent&text=CreateLivenessSessionContent\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.setDeviceCorrelationId(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.setDeviceCorrelationId(String deviceCorrelationId)"
|
||||
name: "setDeviceCorrelationId(String deviceCorrelationId)"
|
||||
nameWithType: "CreateLivenessSessionContent.setDeviceCorrelationId(String deviceCorrelationId)"
|
||||
summary: "Set the device<wbr>Correlation<wbr>Id property: Unique Guid per each end-user device."
|
||||
parameters:
|
||||
- description: "the deviceCorrelationId value to set."
|
||||
name: "deviceCorrelationId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateLivenessSessionContent setDeviceCorrelationId(String deviceCorrelationId)"
|
||||
desc: "Set the deviceCorrelationId property: Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null."
|
||||
returns:
|
||||
description: "the CreateLivenessSessionContent object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionContent?alt=com.azure.ai.vision.face.models.CreateLivenessSessionContent&text=CreateLivenessSessionContent\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.setDeviceCorrelationIdSetInClient(java.lang.Boolean)"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.setDeviceCorrelationIdSetInClient(Boolean deviceCorrelationIdSetInClient)"
|
||||
name: "setDeviceCorrelationIdSetInClient(Boolean deviceCorrelationIdSetInClient)"
|
||||
nameWithType: "CreateLivenessSessionContent.setDeviceCorrelationIdSetInClient(Boolean deviceCorrelationIdSetInClient)"
|
||||
summary: "Set the device<wbr>Correlation<wbr>IdSet<wbr>InClient property: Whether or not to allow client to set their own 'device<wbr>Correlation<wbr>Id' via the Vision SDK."
|
||||
parameters:
|
||||
- description: "the deviceCorrelationIdSetInClient value to set."
|
||||
name: "deviceCorrelationIdSetInClient"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public CreateLivenessSessionContent setDeviceCorrelationIdSetInClient(Boolean deviceCorrelationIdSetInClient)"
|
||||
desc: "Set the deviceCorrelationIdSetInClient property: Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body."
|
||||
returns:
|
||||
description: "the CreateLivenessSessionContent object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionContent?alt=com.azure.ai.vision.face.models.CreateLivenessSessionContent&text=CreateLivenessSessionContent\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.setSendResultsToClient(java.lang.Boolean)"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionContent.setSendResultsToClient(Boolean sendResultsToClient)"
|
||||
name: "setSendResultsToClient(Boolean sendResultsToClient)"
|
||||
nameWithType: "CreateLivenessSessionContent.setSendResultsToClient(Boolean sendResultsToClient)"
|
||||
summary: "Set the send<wbr>Results<wbr>ToClient property: Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons."
|
||||
parameters:
|
||||
- description: "the sendResultsToClient value to set."
|
||||
name: "sendResultsToClient"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public CreateLivenessSessionContent setSendResultsToClient(Boolean sendResultsToClient)"
|
||||
desc: "Set the sendResultsToClient property: Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons. Default is false, clients will receive a '204 - NoContent' empty body response. Regardless of selection, calling Session GetResult will always contain a response body enabling business logic to be implemented."
|
||||
returns:
|
||||
description: "the CreateLivenessSessionContent object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.CreateLivenessSessionContent?alt=com.azure.ai.vision.face.models.CreateLivenessSessionContent&text=CreateLivenessSessionContent\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request for creating liveness session."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.CreateLivenessSessionResult"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionResult"
|
||||
name: "CreateLivenessSessionResult"
|
||||
nameWithType: "CreateLivenessSessionResult"
|
||||
summary: "Response of liveness session creation."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **CreateLivenessSessionResult**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionResult.getAuthToken()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionResult.getAuthToken()"
|
||||
name: "getAuthToken()"
|
||||
nameWithType: "CreateLivenessSessionResult.getAuthToken()"
|
||||
summary: "Get the auth<wbr>Token property: Bearer token to provide authentication for the Vision SDK running on a client application."
|
||||
syntax: "public String getAuthToken()"
|
||||
desc: "Get the authToken property: Bearer token to provide authentication for the Vision SDK running on a client application. This Bearer token has limited permissions to perform only the required action and expires after the TTL time. It is also auditable."
|
||||
returns:
|
||||
description: "the authToken value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessSessionResult.getSessionId()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessSessionResult.getSessionId()"
|
||||
name: "getSessionId()"
|
||||
nameWithType: "CreateLivenessSessionResult.getSessionId()"
|
||||
summary: "Get the session<wbr>Id property: The unique session ID of the created session."
|
||||
syntax: "public String getSessionId()"
|
||||
desc: "Get the sessionId property: The unique session ID of the created session. It will expire 48 hours after it was created or may be deleted sooner using the corresponding Session DELETE operation."
|
||||
returns:
|
||||
description: "the sessionId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Response of liveness session creation."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult"
|
||||
name: "CreateLivenessWithVerifySessionResult"
|
||||
nameWithType: "CreateLivenessWithVerifySessionResult"
|
||||
summary: "Response of liveness session with verify creation with verify image provided."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **CreateLivenessWithVerifySessionResult**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult.getAuthToken()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult.getAuthToken()"
|
||||
name: "getAuthToken()"
|
||||
nameWithType: "CreateLivenessWithVerifySessionResult.getAuthToken()"
|
||||
summary: "Get the auth<wbr>Token property: Bearer token to provide authentication for the Vision SDK running on a client application."
|
||||
syntax: "public String getAuthToken()"
|
||||
desc: "Get the authToken property: Bearer token to provide authentication for the Vision SDK running on a client application. This Bearer token has limited permissions to perform only the required action and expires after the TTL time. It is also auditable."
|
||||
returns:
|
||||
description: "the authToken value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult.getSessionId()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult.getSessionId()"
|
||||
name: "getSessionId()"
|
||||
nameWithType: "CreateLivenessWithVerifySessionResult.getSessionId()"
|
||||
summary: "Get the session<wbr>Id property: The unique session ID of the created session."
|
||||
syntax: "public String getSessionId()"
|
||||
desc: "Get the sessionId property: The unique session ID of the created session. It will expire 48 hours after it was created or may be deleted sooner using the corresponding Session DELETE operation."
|
||||
returns:
|
||||
description: "the sessionId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult.getVerifyImage()"
|
||||
fullName: "com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult.getVerifyImage()"
|
||||
name: "getVerifyImage()"
|
||||
nameWithType: "CreateLivenessWithVerifySessionResult.getVerifyImage()"
|
||||
summary: "Get the verify<wbr>Image property: The detail of face for verification."
|
||||
syntax: "public LivenessWithVerifyImage getVerifyImage()"
|
||||
desc: "Get the verifyImage property: The detail of face for verification."
|
||||
returns:
|
||||
description: "the verifyImage value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessWithVerifyImage?alt=com.azure.ai.vision.face.models.LivenessWithVerifyImage&text=LivenessWithVerifyImage\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Response of liveness session with verify creation with verify image provided."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,215 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.DetectOptions"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions"
|
||||
name: "DetectOptions"
|
||||
nameWithType: "DetectOptions"
|
||||
summary: "Options for detect<wbr>From<wbr>Url API."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DetectOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.DetectOptions(com.azure.ai.vision.face.models.FaceDetectionModel,com.azure.ai.vision.face.models.FaceRecognitionModel,boolean)"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.DetectOptions(FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
name: "DetectOptions(FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
nameWithType: "DetectOptions.DetectOptions(FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
summary: "Creates an instance of Detect<wbr>From<wbr>Url<wbr>Options class."
|
||||
parameters:
|
||||
- description: "The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel'\n values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'"
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel'\n values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'. The default value is\n 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared\n with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "Return faceIds of the detected faces or not. The default value is true."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public DetectOptions(FaceDetectionModel detectionModel, FaceRecognitionModel recognitionModel, boolean returnFaceId)"
|
||||
desc: "Creates an instance of DetectFromUrlOptions class."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.getDetectionModel()"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.getDetectionModel()"
|
||||
name: "getDetectionModel()"
|
||||
nameWithType: "DetectOptions.getDetectionModel()"
|
||||
summary: "Get the detection<wbr>Model property: The 'detection<wbr>Model' associated with the detected face<wbr>Ids."
|
||||
syntax: "public FaceDetectionModel getDetectionModel()"
|
||||
desc: "Get the detectionModel property: The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection\\_01', 'detection\\_02' and 'detection\\_03'. The default value is 'detection\\_01'."
|
||||
returns:
|
||||
description: "the detectionModel value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.getFaceIdTimeToLive()"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.getFaceIdTimeToLive()"
|
||||
name: "getFaceIdTimeToLive()"
|
||||
nameWithType: "DetectOptions.getFaceIdTimeToLive()"
|
||||
summary: "Get the face<wbr>IdTime<wbr>ToLive property: The number of seconds for the face ID being cached."
|
||||
syntax: "public Integer getFaceIdTimeToLive()"
|
||||
desc: "Get the faceIdTimeToLive property: The number of seconds for the face ID being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours)."
|
||||
returns:
|
||||
description: "the faceIdTimeToLive value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.getRecognitionModel()"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.getRecognitionModel()"
|
||||
name: "getRecognitionModel()"
|
||||
nameWithType: "DetectOptions.getRecognitionModel()"
|
||||
summary: "Get the recognition<wbr>Model property: The 'recognition<wbr>Model' associated with the detected face<wbr>Ids."
|
||||
syntax: "public FaceRecognitionModel getRecognitionModel()"
|
||||
desc: "Get the recognitionModel property: The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition\\_01', 'recognition\\_02', 'recognition\\_03' or 'recognition\\_04'. The default value is 'recognition\\_01'. 'recognition\\_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition\\_03', and its overall accuracy is improved compared with 'recognition\\_01' and 'recognition\\_02'."
|
||||
returns:
|
||||
description: "the recognitionModel value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.getReturnFaceAttributes()"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.getReturnFaceAttributes()"
|
||||
name: "getReturnFaceAttributes()"
|
||||
nameWithType: "DetectOptions.getReturnFaceAttributes()"
|
||||
summary: "Get the return<wbr>Face<wbr>Attributes property: Analyze and return the one or more specified face attributes in the comma-separated string like 'return<wbr>Face<wbr>Attributes=head<wbr>Pose,glasses'."
|
||||
syntax: "public List<FaceAttributeType> getReturnFaceAttributes()"
|
||||
desc: "Get the returnFaceAttributes property: Analyze and return the one or more specified face attributes in the comma-separated string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and time cost."
|
||||
returns:
|
||||
description: "the returnFaceAttributes value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.isReturnFaceId()"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.isReturnFaceId()"
|
||||
name: "isReturnFaceId()"
|
||||
nameWithType: "DetectOptions.isReturnFaceId()"
|
||||
summary: "Get the return<wbr>Face<wbr>Id property: Return face<wbr>Ids of the detected faces or not."
|
||||
syntax: "public boolean isReturnFaceId()"
|
||||
desc: "Get the returnFaceId property: Return faceIds of the detected faces or not. The default value is true."
|
||||
returns:
|
||||
description: "the returnFaceId value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.isReturnFaceLandmarks()"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.isReturnFaceLandmarks()"
|
||||
name: "isReturnFaceLandmarks()"
|
||||
nameWithType: "DetectOptions.isReturnFaceLandmarks()"
|
||||
summary: "Get the return<wbr>Face<wbr>Landmarks property: Return face landmarks of the detected faces or not."
|
||||
syntax: "public Boolean isReturnFaceLandmarks()"
|
||||
desc: "Get the returnFaceLandmarks property: Return face landmarks of the detected faces or not. The default value is false."
|
||||
returns:
|
||||
description: "the returnFaceLandmarks value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.isReturnRecognitionModel()"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.isReturnRecognitionModel()"
|
||||
name: "isReturnRecognitionModel()"
|
||||
nameWithType: "DetectOptions.isReturnRecognitionModel()"
|
||||
summary: "Get the return<wbr>Recognition<wbr>Model property: Return 'recognition<wbr>Model' or not."
|
||||
syntax: "public Boolean isReturnRecognitionModel()"
|
||||
desc: "Get the returnRecognitionModel property: Return 'recognitionModel' or not. The default value is false."
|
||||
returns:
|
||||
description: "the returnRecognitionModel value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.setDetectionModel(com.azure.ai.vision.face.models.FaceDetectionModel)"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.setDetectionModel(FaceDetectionModel detectionModel)"
|
||||
name: "setDetectionModel(FaceDetectionModel detectionModel)"
|
||||
nameWithType: "DetectOptions.setDetectionModel(FaceDetectionModel detectionModel)"
|
||||
summary: "Set the detection<wbr>Model property: The 'detection<wbr>Model' associated with the detected face<wbr>Ids."
|
||||
parameters:
|
||||
- description: "the detectionModel value to set."
|
||||
name: "detectionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public DetectOptions setDetectionModel(FaceDetectionModel detectionModel)"
|
||||
desc: "Set the detectionModel property: The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection\\_01', 'detection\\_02' and 'detection\\_03'. The default value is 'detection\\_01'."
|
||||
returns:
|
||||
description: "the DetectFromUrlOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.setFaceIdTimeToLive(java.lang.Integer)"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.setFaceIdTimeToLive(Integer faceIdTimeToLive)"
|
||||
name: "setFaceIdTimeToLive(Integer faceIdTimeToLive)"
|
||||
nameWithType: "DetectOptions.setFaceIdTimeToLive(Integer faceIdTimeToLive)"
|
||||
summary: "Set the face<wbr>IdTime<wbr>ToLive property: The number of seconds for the face ID being cached."
|
||||
parameters:
|
||||
- description: "the faceIdTimeToLive value to set."
|
||||
name: "faceIdTimeToLive"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public DetectOptions setFaceIdTimeToLive(Integer faceIdTimeToLive)"
|
||||
desc: "Set the faceIdTimeToLive property: The number of seconds for the face ID being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours)."
|
||||
returns:
|
||||
description: "the DetectFromUrlOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.setRecognitionModel(com.azure.ai.vision.face.models.FaceRecognitionModel)"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.setRecognitionModel(FaceRecognitionModel recognitionModel)"
|
||||
name: "setRecognitionModel(FaceRecognitionModel recognitionModel)"
|
||||
nameWithType: "DetectOptions.setRecognitionModel(FaceRecognitionModel recognitionModel)"
|
||||
summary: "Set the recognition<wbr>Model property: The 'recognition<wbr>Model' associated with the detected face<wbr>Ids."
|
||||
parameters:
|
||||
- description: "the recognitionModel value to set."
|
||||
name: "recognitionModel"
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public DetectOptions setRecognitionModel(FaceRecognitionModel recognitionModel)"
|
||||
desc: "Set the recognitionModel property: The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition\\_01', 'recognition\\_02', 'recognition\\_03' or 'recognition\\_04'. The default value is 'recognition\\_01'. 'recognition\\_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition\\_03', and its overall accuracy is improved compared with 'recognition\\_01' and 'recognition\\_02'."
|
||||
returns:
|
||||
description: "the DetectFromUrlOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.setReturnFaceAttributes(java.util.List<com.azure.ai.vision.face.models.FaceAttributeType>)"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.setReturnFaceAttributes(List<FaceAttributeType> returnFaceAttributes)"
|
||||
name: "setReturnFaceAttributes(List<FaceAttributeType> returnFaceAttributes)"
|
||||
nameWithType: "DetectOptions.setReturnFaceAttributes(List<FaceAttributeType> returnFaceAttributes)"
|
||||
summary: "Set the return<wbr>Face<wbr>Attributes property: Analyze and return the one or more specified face attributes in the comma-separated string like 'return<wbr>Face<wbr>Attributes=head<wbr>Pose,glasses'."
|
||||
parameters:
|
||||
- description: "the returnFaceAttributes value to set."
|
||||
name: "returnFaceAttributes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public DetectOptions setReturnFaceAttributes(List<FaceAttributeType> returnFaceAttributes)"
|
||||
desc: "Set the returnFaceAttributes property: Analyze and return the one or more specified face attributes in the comma-separated string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and time cost."
|
||||
returns:
|
||||
description: "the DetectFromUrlOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.setReturnFaceId(boolean)"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.setReturnFaceId(boolean returnFaceId)"
|
||||
name: "setReturnFaceId(boolean returnFaceId)"
|
||||
nameWithType: "DetectOptions.setReturnFaceId(boolean returnFaceId)"
|
||||
summary: "Set the return<wbr>Face<wbr>Id property: Return face<wbr>Ids of the detected faces or not."
|
||||
parameters:
|
||||
- description: "the returnFaceId value to set."
|
||||
name: "returnFaceId"
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public DetectOptions setReturnFaceId(boolean returnFaceId)"
|
||||
desc: "Set the returnFaceId property: Return faceIds of the detected faces or not. The default value is true."
|
||||
returns:
|
||||
description: "the DetectFromUrlOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.setReturnFaceLandmarks(java.lang.Boolean)"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.setReturnFaceLandmarks(Boolean returnFaceLandmarks)"
|
||||
name: "setReturnFaceLandmarks(Boolean returnFaceLandmarks)"
|
||||
nameWithType: "DetectOptions.setReturnFaceLandmarks(Boolean returnFaceLandmarks)"
|
||||
summary: "Set the return<wbr>Face<wbr>Landmarks property: Return face landmarks of the detected faces or not."
|
||||
parameters:
|
||||
- description: "the returnFaceLandmarks value to set."
|
||||
name: "returnFaceLandmarks"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public DetectOptions setReturnFaceLandmarks(Boolean returnFaceLandmarks)"
|
||||
desc: "Set the returnFaceLandmarks property: Return face landmarks of the detected faces or not. The default value is false."
|
||||
returns:
|
||||
description: "the DetectFromUrlOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.DetectOptions.setReturnRecognitionModel(java.lang.Boolean)"
|
||||
fullName: "com.azure.ai.vision.face.models.DetectOptions.setReturnRecognitionModel(Boolean returnRecognitionModel)"
|
||||
name: "setReturnRecognitionModel(Boolean returnRecognitionModel)"
|
||||
nameWithType: "DetectOptions.setReturnRecognitionModel(Boolean returnRecognitionModel)"
|
||||
summary: "Set the return<wbr>Recognition<wbr>Model property: Return 'recognition<wbr>Model' or not."
|
||||
parameters:
|
||||
- description: "the returnRecognitionModel value to set."
|
||||
name: "returnRecognitionModel"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public DetectOptions setReturnRecognitionModel(Boolean returnRecognitionModel)"
|
||||
desc: "Set the returnRecognitionModel property: Return 'recognitionModel' or not. The default value is false."
|
||||
returns:
|
||||
description: "the DetectFromUrlOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.DetectOptions?alt=com.azure.ai.vision.face.models.DetectOptions&text=DetectOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Options for detectFromUrl API."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.ExposureLevel"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureLevel"
|
||||
name: "ExposureLevel"
|
||||
nameWithType: "ExposureLevel"
|
||||
summary: "Indicates level of exposure."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **ExposureLevel**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.ExposureLevel?alt=com.azure.ai.vision.face.models.ExposureLevel&text=ExposureLevel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.ExposureLevel.ExposureLevel()"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureLevel.ExposureLevel()"
|
||||
name: "ExposureLevel()"
|
||||
nameWithType: "ExposureLevel.ExposureLevel()"
|
||||
summary: "Creates a new instance of Exposure<wbr>Level value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.ExposureLevel.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ExposureLevel()"
|
||||
desc: "Creates a new instance of ExposureLevel value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.ExposureLevel.GOOD_EXPOSURE"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureLevel.GOOD_EXPOSURE"
|
||||
name: "GOOD_EXPOSURE"
|
||||
nameWithType: "ExposureLevel.GOOD_EXPOSURE"
|
||||
summary: "Good exposure level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.ExposureLevel?alt=com.azure.ai.vision.face.models.ExposureLevel&text=ExposureLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ExposureLevel GOOD_EXPOSURE"
|
||||
desc: "Good exposure level."
|
||||
- uid: "com.azure.ai.vision.face.models.ExposureLevel.OVER_EXPOSURE"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureLevel.OVER_EXPOSURE"
|
||||
name: "OVER_EXPOSURE"
|
||||
nameWithType: "ExposureLevel.OVER_EXPOSURE"
|
||||
summary: "High exposure level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.ExposureLevel?alt=com.azure.ai.vision.face.models.ExposureLevel&text=ExposureLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ExposureLevel OVER_EXPOSURE"
|
||||
desc: "High exposure level."
|
||||
- uid: "com.azure.ai.vision.face.models.ExposureLevel.UNDER_EXPOSURE"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureLevel.UNDER_EXPOSURE"
|
||||
name: "UNDER_EXPOSURE"
|
||||
nameWithType: "ExposureLevel.UNDER_EXPOSURE"
|
||||
summary: "Low exposure level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.ExposureLevel?alt=com.azure.ai.vision.face.models.ExposureLevel&text=ExposureLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ExposureLevel UNDER_EXPOSURE"
|
||||
desc: "Low exposure level."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.ExposureLevel.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureLevel.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "ExposureLevel.fromString(String name)"
|
||||
summary: "Creates or finds a Exposure<wbr>Level from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static ExposureLevel fromString(String name)"
|
||||
desc: "Creates or finds a ExposureLevel from its string representation."
|
||||
returns:
|
||||
description: "the corresponding ExposureLevel."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.ExposureLevel?alt=com.azure.ai.vision.face.models.ExposureLevel&text=ExposureLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.ExposureLevel.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureLevel.values()"
|
||||
name: "values()"
|
||||
nameWithType: "ExposureLevel.values()"
|
||||
summary: "Gets known Exposure<wbr>Level values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<ExposureLevel> values()"
|
||||
desc: "Gets known ExposureLevel values."
|
||||
returns:
|
||||
description: "known ExposureLevel values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.ExposureLevel?alt=com.azure.ai.vision.face.models.ExposureLevel&text=ExposureLevel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Indicates level of exposure."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.ExposureProperties"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureProperties"
|
||||
name: "ExposureProperties"
|
||||
nameWithType: "ExposureProperties"
|
||||
summary: "Properties describing exposure level of the image."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **ExposureProperties**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.ExposureProperties.getExposureLevel()"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureProperties.getExposureLevel()"
|
||||
name: "getExposureLevel()"
|
||||
nameWithType: "ExposureProperties.getExposureLevel()"
|
||||
summary: "Get the exposure<wbr>Level property: An enum value indicating level of exposure."
|
||||
syntax: "public ExposureLevel getExposureLevel()"
|
||||
desc: "Get the exposureLevel property: An enum value indicating level of exposure."
|
||||
returns:
|
||||
description: "the exposureLevel value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.ExposureLevel?alt=com.azure.ai.vision.face.models.ExposureLevel&text=ExposureLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.ExposureProperties.getValue()"
|
||||
fullName: "com.azure.ai.vision.face.models.ExposureProperties.getValue()"
|
||||
name: "getValue()"
|
||||
nameWithType: "ExposureProperties.getValue()"
|
||||
summary: "Get the value property: A number indicating level of exposure level ranging from 0 to 1."
|
||||
syntax: "public double getValue()"
|
||||
desc: "Get the value property: A number indicating level of exposure level ranging from 0 to 1. \\[0, 0.25) is under exposure. \\[0.25, 0.75) is good exposure. \\[0.75, 1\\] is over exposure."
|
||||
returns:
|
||||
description: "the value value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Properties describing exposure level of the image."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,119 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01"
|
||||
name: "FaceAttributeType.ModelDetection01"
|
||||
nameWithType: "FaceAttributeType.ModelDetection01"
|
||||
summary: "Face attribute supported by Detection01."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public static final class **FaceAttributeType.ModelDetection01**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.ModelDetection01()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.ModelDetection01()"
|
||||
name: "ModelDetection01()"
|
||||
nameWithType: "FaceAttributeType.ModelDetection01.ModelDetection01()"
|
||||
syntax: "public ModelDetection01()"
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.ACCESSORIES"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.ACCESSORIES"
|
||||
name: "ACCESSORIES"
|
||||
nameWithType: "FaceAttributeType.ModelDetection01.ACCESSORIES"
|
||||
summary: "Accessories around face, including 'headwear', 'glasses' and 'mask'."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType ACCESSORIES"
|
||||
desc: "Accessories around face, including 'headwear', 'glasses' and 'mask'. Empty array means no accessories detected. Note this is after a face is detected. Large mask could result in no face to be detected."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.BLUR"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.BLUR"
|
||||
name: "BLUR"
|
||||
nameWithType: "FaceAttributeType.ModelDetection01.BLUR"
|
||||
summary: "Face is blurry or not."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType BLUR"
|
||||
desc: "Face is blurry or not. Level returns 'Low', 'Medium' or 'High'. Value returns a number between \\[0,1\\], the larger the blurrier."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.EXPOSURE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.EXPOSURE"
|
||||
name: "EXPOSURE"
|
||||
nameWithType: "FaceAttributeType.ModelDetection01.EXPOSURE"
|
||||
summary: "Face exposure level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType EXPOSURE"
|
||||
desc: "Face exposure level. Level returns 'GoodExposure', 'OverExposure' or 'UnderExposure'."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.GLASSES"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.GLASSES"
|
||||
name: "GLASSES"
|
||||
nameWithType: "FaceAttributeType.ModelDetection01.GLASSES"
|
||||
summary: "Glasses type."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType GLASSES"
|
||||
desc: "Glasses type. Values include 'NoGlasses', 'ReadingGlasses', 'Sunglasses', 'SwimmingGoggles'."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.HEAD_POSE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.HEAD_POSE"
|
||||
name: "HEAD_POSE"
|
||||
nameWithType: "FaceAttributeType.ModelDetection01.HEAD_POSE"
|
||||
summary: "3-D roll/yaw/pitch angles for face direction."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType HEAD_POSE"
|
||||
desc: "3-D roll/yaw/pitch angles for face direction."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.NOISE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.NOISE"
|
||||
name: "NOISE"
|
||||
nameWithType: "FaceAttributeType.ModelDetection01.NOISE"
|
||||
summary: "Noise level of face pixels."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType NOISE"
|
||||
desc: "Noise level of face pixels. Level returns 'Low', 'Medium' and 'High'. Value returns a number between \\[0,1\\], the larger the noisier."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.OCCLUSION"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01.OCCLUSION"
|
||||
name: "OCCLUSION"
|
||||
nameWithType: "FaceAttributeType.ModelDetection01.OCCLUSION"
|
||||
summary: "Whether each facial area is occluded, including forehead, eyes and mouth."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType OCCLUSION"
|
||||
desc: "Whether each facial area is occluded, including forehead, eyes and mouth."
|
||||
type: "class"
|
||||
desc: "Face attribute supported by Detection01."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03"
|
||||
name: "FaceAttributeType.ModelDetection03"
|
||||
nameWithType: "FaceAttributeType.ModelDetection03"
|
||||
summary: "Face attribute supported by Detection03."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public static final class **FaceAttributeType.ModelDetection03**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03.ModelDetection03()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03.ModelDetection03()"
|
||||
name: "ModelDetection03()"
|
||||
nameWithType: "FaceAttributeType.ModelDetection03.ModelDetection03()"
|
||||
syntax: "public ModelDetection03()"
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03.BLUR"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03.BLUR"
|
||||
name: "BLUR"
|
||||
nameWithType: "FaceAttributeType.ModelDetection03.BLUR"
|
||||
summary: "Face is blurry or not."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType BLUR"
|
||||
desc: "Face is blurry or not. Level returns 'Low', 'Medium' or 'High'. Value returns a number between \\[0,1\\], the larger the blurrier."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03.HEAD_POSE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03.HEAD_POSE"
|
||||
name: "HEAD_POSE"
|
||||
nameWithType: "FaceAttributeType.ModelDetection03.HEAD_POSE"
|
||||
summary: "3-D roll/yaw/pitch angles for face direction."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType HEAD_POSE"
|
||||
desc: "3-D roll/yaw/pitch angles for face direction."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03.MASK"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03.MASK"
|
||||
name: "MASK"
|
||||
nameWithType: "FaceAttributeType.ModelDetection03.MASK"
|
||||
summary: "Whether each face is wearing a mask."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType MASK"
|
||||
desc: "Whether each face is wearing a mask. Mask type returns 'noMask', 'faceMask', 'otherMaskOrOcclusion', or 'uncertain'. Value returns a boolean 'noseAndMouthCovered' indicating whether nose and mouth are covered."
|
||||
type: "class"
|
||||
desc: "Face attribute supported by Detection03."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition03"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition03"
|
||||
name: "FaceAttributeType.ModelRecognition03"
|
||||
nameWithType: "FaceAttributeType.ModelRecognition03"
|
||||
summary: "Face attribute supported by Recognition03."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public static final class **FaceAttributeType.ModelRecognition03**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition03.ModelRecognition03()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition03.ModelRecognition03()"
|
||||
name: "ModelRecognition03()"
|
||||
nameWithType: "FaceAttributeType.ModelRecognition03.ModelRecognition03()"
|
||||
syntax: "public ModelRecognition03()"
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition03.QUALITY_FOR_RECOGNITION"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition03.QUALITY_FOR_RECOGNITION"
|
||||
name: "QUALITY_FOR_RECOGNITION"
|
||||
nameWithType: "FaceAttributeType.ModelRecognition03.QUALITY_FOR_RECOGNITION"
|
||||
summary: "The overall image quality regarding whether the image being used in the detection is of sufficient quality to attempt face recognition on."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType QUALITY_FOR_RECOGNITION"
|
||||
desc: "The overall image quality regarding whether the image being used in the detection is of sufficient quality to attempt face recognition on. The value is an informal rating of low, medium, or high. Only 'high' quality images are recommended for person enrollment and quality at or above 'medium' is recommended for identification scenarios. The attribute is only available when using any combinations of detection models detection\\_01 or detection\\_03, and recognition models recognition\\_03 or recognition\\_04."
|
||||
type: "class"
|
||||
desc: "Face attribute supported by Recognition03."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition04"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition04"
|
||||
name: "FaceAttributeType.ModelRecognition04"
|
||||
nameWithType: "FaceAttributeType.ModelRecognition04"
|
||||
summary: "Face attribute supported by Recognition04."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public static final class **FaceAttributeType.ModelRecognition04**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition04.ModelRecognition04()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition04.ModelRecognition04()"
|
||||
name: "ModelRecognition04()"
|
||||
nameWithType: "FaceAttributeType.ModelRecognition04.ModelRecognition04()"
|
||||
syntax: "public ModelRecognition04()"
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition04.QUALITY_FOR_RECOGNITION"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition04.QUALITY_FOR_RECOGNITION"
|
||||
name: "QUALITY_FOR_RECOGNITION"
|
||||
nameWithType: "FaceAttributeType.ModelRecognition04.QUALITY_FOR_RECOGNITION"
|
||||
summary: "The overall image quality regarding whether the image being used in the detection is of sufficient quality to attempt face recognition on."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType QUALITY_FOR_RECOGNITION"
|
||||
desc: "The overall image quality regarding whether the image being used in the detection is of sufficient quality to attempt face recognition on. The value is an informal rating of low, medium, or high. Only 'high' quality images are recommended for person enrollment and quality at or above 'medium' is recommended for identification scenarios. The attribute is only available when using any combinations of detection models detection\\_01 or detection\\_03, and recognition models recognition\\_03 or recognition\\_04."
|
||||
type: "class"
|
||||
desc: "Face attribute supported by Recognition04."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,229 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceAttributeType"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType"
|
||||
name: "FaceAttributeType"
|
||||
nameWithType: "FaceAttributeType"
|
||||
summary: "Available options for detect face with attribute."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceAttributeType**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.FaceAttributeType()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.FaceAttributeType()"
|
||||
name: "FaceAttributeType()"
|
||||
nameWithType: "FaceAttributeType.FaceAttributeType()"
|
||||
summary: "Creates a new instance of Face<wbr>Attribute<wbr>Type value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.FaceAttributeType.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public FaceAttributeType()"
|
||||
desc: "Creates a new instance of FaceAttributeType value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.ACCESSORIES"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.ACCESSORIES"
|
||||
name: "ACCESSORIES"
|
||||
nameWithType: "FaceAttributeType.ACCESSORIES"
|
||||
summary: "Accessories around face, including 'headwear', 'glasses' and 'mask'."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType ACCESSORIES"
|
||||
desc: "Accessories around face, including 'headwear', 'glasses' and 'mask'. Empty array means no accessories detected. Note this is after a face is detected. Large mask could result in no face to be detected."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.AGE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.AGE"
|
||||
name: "AGE"
|
||||
nameWithType: "FaceAttributeType.AGE"
|
||||
summary: "Age in years."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType AGE"
|
||||
desc: "Age in years."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.BLUR"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.BLUR"
|
||||
name: "BLUR"
|
||||
nameWithType: "FaceAttributeType.BLUR"
|
||||
summary: "Face is blurry or not."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType BLUR"
|
||||
desc: "Face is blurry or not. Level returns 'Low', 'Medium' or 'High'. Value returns a number between \\[0,1\\], the larger the blurrier."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.EXPOSURE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.EXPOSURE"
|
||||
name: "EXPOSURE"
|
||||
nameWithType: "FaceAttributeType.EXPOSURE"
|
||||
summary: "Face exposure level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType EXPOSURE"
|
||||
desc: "Face exposure level. Level returns 'GoodExposure', 'OverExposure' or 'UnderExposure'."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.FACIAL_HAIR"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.FACIAL_HAIR"
|
||||
name: "FACIAL_HAIR"
|
||||
nameWithType: "FaceAttributeType.FACIAL_HAIR"
|
||||
summary: "Properties describing facial hair attributes."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType FACIAL_HAIR"
|
||||
desc: "Properties describing facial hair attributes."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.GLASSES"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.GLASSES"
|
||||
name: "GLASSES"
|
||||
nameWithType: "FaceAttributeType.GLASSES"
|
||||
summary: "Glasses type."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType GLASSES"
|
||||
desc: "Glasses type. Values include 'NoGlasses', 'ReadingGlasses', 'Sunglasses', 'SwimmingGoggles'."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.HAIR"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.HAIR"
|
||||
name: "HAIR"
|
||||
nameWithType: "FaceAttributeType.HAIR"
|
||||
summary: "Properties describing hair attributes."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType HAIR"
|
||||
desc: "Properties describing hair attributes."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.HEAD_POSE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.HEAD_POSE"
|
||||
name: "HEAD_POSE"
|
||||
nameWithType: "FaceAttributeType.HEAD_POSE"
|
||||
summary: "3-D roll/yaw/pitch angles for face direction."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType HEAD_POSE"
|
||||
desc: "3-D roll/yaw/pitch angles for face direction."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.MASK"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.MASK"
|
||||
name: "MASK"
|
||||
nameWithType: "FaceAttributeType.MASK"
|
||||
summary: "Whether each face is wearing a mask."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType MASK"
|
||||
desc: "Whether each face is wearing a mask. Mask type returns 'noMask', 'faceMask', 'otherMaskOrOcclusion', or 'uncertain'. Value returns a boolean 'noseAndMouthCovered' indicating whether nose and mouth are covered."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.NOISE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.NOISE"
|
||||
name: "NOISE"
|
||||
nameWithType: "FaceAttributeType.NOISE"
|
||||
summary: "Noise level of face pixels."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType NOISE"
|
||||
desc: "Noise level of face pixels. Level returns 'Low', 'Medium' and 'High'. Value returns a number between \\[0,1\\], the larger the noisier."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.OCCLUSION"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.OCCLUSION"
|
||||
name: "OCCLUSION"
|
||||
nameWithType: "FaceAttributeType.OCCLUSION"
|
||||
summary: "Whether each facial area is occluded, including forehead, eyes and mouth."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType OCCLUSION"
|
||||
desc: "Whether each facial area is occluded, including forehead, eyes and mouth."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.QUALITY_FOR_RECOGNITION"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.QUALITY_FOR_RECOGNITION"
|
||||
name: "QUALITY_FOR_RECOGNITION"
|
||||
nameWithType: "FaceAttributeType.QUALITY_FOR_RECOGNITION"
|
||||
summary: "The overall image quality regarding whether the image being used in the detection is of sufficient quality to attempt face recognition on."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType QUALITY_FOR_RECOGNITION"
|
||||
desc: "The overall image quality regarding whether the image being used in the detection is of sufficient quality to attempt face recognition on. The value is an informal rating of low, medium, or high. Only 'high' quality images are recommended for person enrollment and quality at or above 'medium' is recommended for identification scenarios. The attribute is only available when using recognition models recognition\\_03 or recognition\\_04."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.SMILE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.SMILE"
|
||||
name: "SMILE"
|
||||
nameWithType: "FaceAttributeType.SMILE"
|
||||
summary: "Smile intensity, a number between \\[0,1\\]."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceAttributeType SMILE"
|
||||
desc: "Smile intensity, a number between \\[0,1\\]."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "FaceAttributeType.fromString(String name)"
|
||||
summary: "Creates or finds a Face<wbr>Attribute<wbr>Type from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FaceAttributeType fromString(String name)"
|
||||
desc: "Creates or finds a FaceAttributeType from its string representation."
|
||||
returns:
|
||||
description: "the corresponding FaceAttributeType."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributeType.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributeType.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FaceAttributeType.values()"
|
||||
summary: "Gets known Face<wbr>Attribute<wbr>Type values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<FaceAttributeType> values()"
|
||||
desc: "Gets known FaceAttributeType values."
|
||||
returns:
|
||||
description: "known FaceAttributeType values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.FaceAttributeType?alt=com.azure.ai.vision.face.models.FaceAttributeType&text=FaceAttributeType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Available options for detect face with attribute."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,159 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceAttributes"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes"
|
||||
name: "FaceAttributes"
|
||||
nameWithType: "FaceAttributes"
|
||||
summary: "Face attributes for the detected face."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceAttributes**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getAccessories()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getAccessories()"
|
||||
name: "getAccessories()"
|
||||
nameWithType: "FaceAttributes.getAccessories()"
|
||||
summary: "Get the accessories property: Properties describing any accessories on a given face."
|
||||
syntax: "public List<AccessoryItem> getAccessories()"
|
||||
desc: "Get the accessories property: Properties describing any accessories on a given face."
|
||||
returns:
|
||||
description: "the accessories value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.AccessoryItem?alt=com.azure.ai.vision.face.models.AccessoryItem&text=AccessoryItem\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getAge()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getAge()"
|
||||
name: "getAge()"
|
||||
nameWithType: "FaceAttributes.getAge()"
|
||||
summary: "Get the age property: Age in years."
|
||||
syntax: "public Double getAge()"
|
||||
desc: "Get the age property: Age in years."
|
||||
returns:
|
||||
description: "the age value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getBlur()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getBlur()"
|
||||
name: "getBlur()"
|
||||
nameWithType: "FaceAttributes.getBlur()"
|
||||
summary: "Get the blur property: Properties describing any presence of blur within the image."
|
||||
syntax: "public BlurProperties getBlur()"
|
||||
desc: "Get the blur property: Properties describing any presence of blur within the image."
|
||||
returns:
|
||||
description: "the blur value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.BlurProperties?alt=com.azure.ai.vision.face.models.BlurProperties&text=BlurProperties\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getExposure()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getExposure()"
|
||||
name: "getExposure()"
|
||||
nameWithType: "FaceAttributes.getExposure()"
|
||||
summary: "Get the exposure property: Properties describing exposure level of the image."
|
||||
syntax: "public ExposureProperties getExposure()"
|
||||
desc: "Get the exposure property: Properties describing exposure level of the image."
|
||||
returns:
|
||||
description: "the exposure value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.ExposureProperties?alt=com.azure.ai.vision.face.models.ExposureProperties&text=ExposureProperties\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getFacialHair()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getFacialHair()"
|
||||
name: "getFacialHair()"
|
||||
nameWithType: "FaceAttributes.getFacialHair()"
|
||||
summary: "Get the facial<wbr>Hair property: Properties describing facial hair attributes."
|
||||
syntax: "public FacialHair getFacialHair()"
|
||||
desc: "Get the facialHair property: Properties describing facial hair attributes."
|
||||
returns:
|
||||
description: "the facialHair value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FacialHair?alt=com.azure.ai.vision.face.models.FacialHair&text=FacialHair\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getGlasses()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getGlasses()"
|
||||
name: "getGlasses()"
|
||||
nameWithType: "FaceAttributes.getGlasses()"
|
||||
summary: "Get the glasses property: Glasses type if any of the face."
|
||||
syntax: "public GlassesType getGlasses()"
|
||||
desc: "Get the glasses property: Glasses type if any of the face."
|
||||
returns:
|
||||
description: "the glasses value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.GlassesType?alt=com.azure.ai.vision.face.models.GlassesType&text=GlassesType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getHair()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getHair()"
|
||||
name: "getHair()"
|
||||
nameWithType: "FaceAttributes.getHair()"
|
||||
summary: "Get the hair property: Properties describing hair attributes."
|
||||
syntax: "public HairProperties getHair()"
|
||||
desc: "Get the hair property: Properties describing hair attributes."
|
||||
returns:
|
||||
description: "the hair value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairProperties?alt=com.azure.ai.vision.face.models.HairProperties&text=HairProperties\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getHeadPose()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getHeadPose()"
|
||||
name: "getHeadPose()"
|
||||
nameWithType: "FaceAttributes.getHeadPose()"
|
||||
summary: "Get the head<wbr>Pose property: 3-D roll/yaw/pitch angles for face direction."
|
||||
syntax: "public HeadPose getHeadPose()"
|
||||
desc: "Get the headPose property: 3-D roll/yaw/pitch angles for face direction."
|
||||
returns:
|
||||
description: "the headPose value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HeadPose?alt=com.azure.ai.vision.face.models.HeadPose&text=HeadPose\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getMask()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getMask()"
|
||||
name: "getMask()"
|
||||
nameWithType: "FaceAttributes.getMask()"
|
||||
summary: "Get the mask property: Properties describing the presence of a mask on a given face."
|
||||
syntax: "public MaskProperties getMask()"
|
||||
desc: "Get the mask property: Properties describing the presence of a mask on a given face."
|
||||
returns:
|
||||
description: "the mask value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.MaskProperties?alt=com.azure.ai.vision.face.models.MaskProperties&text=MaskProperties\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getNoise()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getNoise()"
|
||||
name: "getNoise()"
|
||||
nameWithType: "FaceAttributes.getNoise()"
|
||||
summary: "Get the noise property: Properties describing noise level of the image."
|
||||
syntax: "public NoiseProperties getNoise()"
|
||||
desc: "Get the noise property: Properties describing noise level of the image."
|
||||
returns:
|
||||
description: "the noise value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.NoiseProperties?alt=com.azure.ai.vision.face.models.NoiseProperties&text=NoiseProperties\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getOcclusion()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getOcclusion()"
|
||||
name: "getOcclusion()"
|
||||
nameWithType: "FaceAttributes.getOcclusion()"
|
||||
summary: "Get the occlusion property: Properties describing occlusions on a given face."
|
||||
syntax: "public OcclusionProperties getOcclusion()"
|
||||
desc: "Get the occlusion property: Properties describing occlusions on a given face."
|
||||
returns:
|
||||
description: "the occlusion value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.OcclusionProperties?alt=com.azure.ai.vision.face.models.OcclusionProperties&text=OcclusionProperties\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getQualityForRecognition()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getQualityForRecognition()"
|
||||
name: "getQualityForRecognition()"
|
||||
nameWithType: "FaceAttributes.getQualityForRecognition()"
|
||||
summary: "Get the quality<wbr>For<wbr>Recognition property: Properties describing the overall image quality regarding whether the image being used in the detection is of sufficient quality to attempt face recognition on."
|
||||
syntax: "public QualityForRecognition getQualityForRecognition()"
|
||||
desc: "Get the qualityForRecognition property: Properties describing the overall image quality regarding whether the image being used in the detection is of sufficient quality to attempt face recognition on."
|
||||
returns:
|
||||
description: "the qualityForRecognition value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.QualityForRecognition?alt=com.azure.ai.vision.face.models.QualityForRecognition&text=QualityForRecognition\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceAttributes.getSmile()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceAttributes.getSmile()"
|
||||
name: "getSmile()"
|
||||
nameWithType: "FaceAttributes.getSmile()"
|
||||
summary: "Get the smile property: Smile intensity, a number between \\[0,1\\]."
|
||||
syntax: "public Double getSmile()"
|
||||
desc: "Get the smile property: Smile intensity, a number between \\[0,1\\]."
|
||||
returns:
|
||||
description: "the smile value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
||||
type: "class"
|
||||
desc: "Face attributes for the detected face."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceDetectionModel"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionModel"
|
||||
name: "FaceDetectionModel"
|
||||
nameWithType: "FaceDetectionModel"
|
||||
summary: "The detection model for the face."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceDetectionModel**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionModel.FaceDetectionModel()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionModel.FaceDetectionModel()"
|
||||
name: "FaceDetectionModel()"
|
||||
nameWithType: "FaceDetectionModel.FaceDetectionModel()"
|
||||
summary: "Creates a new instance of Face<wbr>Detection<wbr>Model value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.FaceDetectionModel.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public FaceDetectionModel()"
|
||||
desc: "Creates a new instance of FaceDetectionModel value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionModel.DETECTION_01"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionModel.DETECTION_01"
|
||||
name: "DETECTION_01"
|
||||
nameWithType: "FaceDetectionModel.DETECTION_01"
|
||||
summary: "The default detection model."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceDetectionModel DETECTION_01"
|
||||
desc: "The default detection model. Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionModel.DETECTION_02"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionModel.DETECTION_02"
|
||||
name: "DETECTION_02"
|
||||
nameWithType: "FaceDetectionModel.DETECTION_02"
|
||||
summary: "Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceDetectionModel DETECTION_02"
|
||||
desc: "Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionModel.DETECTION_03"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionModel.DETECTION_03"
|
||||
name: "DETECTION_03"
|
||||
nameWithType: "FaceDetectionModel.DETECTION_03"
|
||||
summary: "Detection model released in 2021 February with improved accuracy especially on small faces."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceDetectionModel DETECTION_03"
|
||||
desc: "Detection model released in 2021 February with improved accuracy especially on small faces."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionModel.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionModel.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "FaceDetectionModel.fromString(String name)"
|
||||
summary: "Creates or finds a Face<wbr>Detection<wbr>Model from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FaceDetectionModel fromString(String name)"
|
||||
desc: "Creates or finds a FaceDetectionModel from its string representation."
|
||||
returns:
|
||||
description: "the corresponding FaceDetectionModel."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionModel.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionModel.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FaceDetectionModel.values()"
|
||||
summary: "Gets known Face<wbr>Detection<wbr>Model values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<FaceDetectionModel> values()"
|
||||
desc: "Gets known FaceDetectionModel values."
|
||||
returns:
|
||||
description: "known FaceDetectionModel values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.FaceDetectionModel?alt=com.azure.ai.vision.face.models.FaceDetectionModel&text=FaceDetectionModel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "The detection model for the face."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceDetectionResult"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionResult"
|
||||
name: "FaceDetectionResult"
|
||||
nameWithType: "FaceDetectionResult"
|
||||
summary: "Response for detect API."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceDetectionResult**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionResult.getFaceAttributes()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionResult.getFaceAttributes()"
|
||||
name: "getFaceAttributes()"
|
||||
nameWithType: "FaceDetectionResult.getFaceAttributes()"
|
||||
summary: "Get the face<wbr>Attributes property: Face attributes for detected face."
|
||||
syntax: "public FaceAttributes getFaceAttributes()"
|
||||
desc: "Get the faceAttributes property: Face attributes for detected face."
|
||||
returns:
|
||||
description: "the faceAttributes value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceAttributes?alt=com.azure.ai.vision.face.models.FaceAttributes&text=FaceAttributes\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionResult.getFaceId()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionResult.getFaceId()"
|
||||
name: "getFaceId()"
|
||||
nameWithType: "FaceDetectionResult.getFaceId()"
|
||||
summary: "Get the face<wbr>Id property: Unique face<wbr>Id of the detected face, created by detection API and it will expire 24 hours after the detection call."
|
||||
syntax: "public String getFaceId()"
|
||||
desc: "Get the faceId property: Unique faceId of the detected face, created by detection API and it will expire 24 hours after the detection call. To return this, it requires 'returnFaceId' parameter to be true."
|
||||
returns:
|
||||
description: "the faceId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionResult.getFaceLandmarks()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionResult.getFaceLandmarks()"
|
||||
name: "getFaceLandmarks()"
|
||||
nameWithType: "FaceDetectionResult.getFaceLandmarks()"
|
||||
summary: "Get the face<wbr>Landmarks property: An array of 27-point face landmarks pointing to the important positions of face components."
|
||||
syntax: "public FaceLandmarks getFaceLandmarks()"
|
||||
desc: "Get the faceLandmarks property: An array of 27-point face landmarks pointing to the important positions of face components. To return this, it requires 'returnFaceLandmarks' parameter to be true."
|
||||
returns:
|
||||
description: "the faceLandmarks value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceLandmarks?alt=com.azure.ai.vision.face.models.FaceLandmarks&text=FaceLandmarks\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionResult.getFaceRectangle()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionResult.getFaceRectangle()"
|
||||
name: "getFaceRectangle()"
|
||||
nameWithType: "FaceDetectionResult.getFaceRectangle()"
|
||||
summary: "Get the face<wbr>Rectangle property: A rectangle area for the face location on image."
|
||||
syntax: "public FaceRectangle getFaceRectangle()"
|
||||
desc: "Get the faceRectangle property: A rectangle area for the face location on image."
|
||||
returns:
|
||||
description: "the faceRectangle value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRectangle?alt=com.azure.ai.vision.face.models.FaceRectangle&text=FaceRectangle\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceDetectionResult.getRecognitionModel()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceDetectionResult.getRecognitionModel()"
|
||||
name: "getRecognitionModel()"
|
||||
nameWithType: "FaceDetectionResult.getRecognitionModel()"
|
||||
summary: "Get the recognition<wbr>Model property: The 'recognition<wbr>Model' associated with this face<wbr>Id."
|
||||
syntax: "public FaceRecognitionModel getRecognitionModel()"
|
||||
desc: "Get the recognitionModel property: The 'recognitionModel' associated with this faceId. This is only returned when 'returnRecognitionModel' is explicitly set as true."
|
||||
returns:
|
||||
description: "the recognitionModel value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Response for detect API."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceFindSimilarResult"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceFindSimilarResult"
|
||||
name: "FaceFindSimilarResult"
|
||||
nameWithType: "FaceFindSimilarResult"
|
||||
summary: "Response body for find similar face operation."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceFindSimilarResult**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceFindSimilarResult.getConfidence()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceFindSimilarResult.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "FaceFindSimilarResult.getConfidence()"
|
||||
summary: "Get the confidence property: Confidence value of the candidate."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: Confidence value of the candidate. The higher confidence, the more similar. Range between \\[0,1\\]."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceFindSimilarResult.getFaceId()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceFindSimilarResult.getFaceId()"
|
||||
name: "getFaceId()"
|
||||
nameWithType: "FaceFindSimilarResult.getFaceId()"
|
||||
summary: "Get the face<wbr>Id property: face<wbr>Id of candidate face when find by face<wbr>Ids."
|
||||
syntax: "public String getFaceId()"
|
||||
desc: "Get the faceId property: faceId of candidate face when find by faceIds. faceId is created by \"Detect\" and will expire 24 hours after the detection call."
|
||||
returns:
|
||||
description: "the faceId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceFindSimilarResult.getPersistedFaceId()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceFindSimilarResult.getPersistedFaceId()"
|
||||
name: "getPersistedFaceId()"
|
||||
nameWithType: "FaceFindSimilarResult.getPersistedFaceId()"
|
||||
summary: "Get the persisted<wbr>Face<wbr>Id property: persisted<wbr>Face<wbr>Id of candidate face when find by face<wbr>List<wbr>Id or large<wbr>Face<wbr>List<wbr>Id."
|
||||
syntax: "public String getPersistedFaceId()"
|
||||
desc: "Get the persistedFaceId property: persistedFaceId of candidate face when find by faceListId or largeFaceListId. persistedFaceId in face list/large face list is persisted and will not expire."
|
||||
returns:
|
||||
description: "the persistedFaceId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Response body for find similar face operation."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceGroupingResult"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceGroupingResult"
|
||||
name: "FaceGroupingResult"
|
||||
nameWithType: "FaceGroupingResult"
|
||||
summary: "Response body for group face operation."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceGroupingResult**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceGroupingResult.getGroups()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceGroupingResult.getGroups()"
|
||||
name: "getGroups()"
|
||||
nameWithType: "FaceGroupingResult.getGroups()"
|
||||
summary: "Get the groups property: A partition of the original faces based on face similarity."
|
||||
syntax: "public List<List<String>> getGroups()"
|
||||
desc: "Get the groups property: A partition of the original faces based on face similarity. Groups are ranked by number of faces."
|
||||
returns:
|
||||
description: "the groups value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>>"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceGroupingResult.getMessyGroup()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceGroupingResult.getMessyGroup()"
|
||||
name: "getMessyGroup()"
|
||||
nameWithType: "FaceGroupingResult.getMessyGroup()"
|
||||
summary: "Get the messy<wbr>Group property: Face ids array of faces that cannot find any similar faces from original faces."
|
||||
syntax: "public List<String> getMessyGroup()"
|
||||
desc: "Get the messyGroup property: Face ids array of faces that cannot find any similar faces from original faces."
|
||||
returns:
|
||||
description: "the messyGroup value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
type: "class"
|
||||
desc: "Response body for group face operation."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceImageType"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceImageType"
|
||||
name: "FaceImageType"
|
||||
nameWithType: "FaceImageType"
|
||||
summary: "The type of image."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceImageType**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.FaceImageType?alt=com.azure.ai.vision.face.models.FaceImageType&text=FaceImageType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceImageType.FaceImageType()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceImageType.FaceImageType()"
|
||||
name: "FaceImageType()"
|
||||
nameWithType: "FaceImageType.FaceImageType()"
|
||||
summary: "Creates a new instance of Face<wbr>Image<wbr>Type value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.FaceImageType.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public FaceImageType()"
|
||||
desc: "Creates a new instance of FaceImageType value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceImageType.COLOR"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceImageType.COLOR"
|
||||
name: "COLOR"
|
||||
nameWithType: "FaceImageType.COLOR"
|
||||
summary: "Color image."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceImageType?alt=com.azure.ai.vision.face.models.FaceImageType&text=FaceImageType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceImageType COLOR"
|
||||
desc: "Color image."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceImageType.DEPTH"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceImageType.DEPTH"
|
||||
name: "DEPTH"
|
||||
nameWithType: "FaceImageType.DEPTH"
|
||||
summary: "Depth image."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceImageType?alt=com.azure.ai.vision.face.models.FaceImageType&text=FaceImageType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceImageType DEPTH"
|
||||
desc: "Depth image."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceImageType.INFRARED"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceImageType.INFRARED"
|
||||
name: "INFRARED"
|
||||
nameWithType: "FaceImageType.INFRARED"
|
||||
summary: "Infrared image."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceImageType?alt=com.azure.ai.vision.face.models.FaceImageType&text=FaceImageType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceImageType INFRARED"
|
||||
desc: "Infrared image."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceImageType.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceImageType.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "FaceImageType.fromString(String name)"
|
||||
summary: "Creates or finds a Face<wbr>Image<wbr>Type from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FaceImageType fromString(String name)"
|
||||
desc: "Creates or finds a FaceImageType from its string representation."
|
||||
returns:
|
||||
description: "the corresponding FaceImageType."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceImageType?alt=com.azure.ai.vision.face.models.FaceImageType&text=FaceImageType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceImageType.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceImageType.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FaceImageType.values()"
|
||||
summary: "Gets known Face<wbr>Image<wbr>Type values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<FaceImageType> values()"
|
||||
desc: "Gets known FaceImageType values."
|
||||
returns:
|
||||
description: "known FaceImageType values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.FaceImageType?alt=com.azure.ai.vision.face.models.FaceImageType&text=FaceImageType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "The type of image."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,299 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceLandmarks"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks"
|
||||
name: "FaceLandmarks"
|
||||
nameWithType: "FaceLandmarks"
|
||||
summary: "A collection of 27-point face landmarks pointing to the important positions of face components."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceLandmarks**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeLeftBottom()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeLeftBottom()"
|
||||
name: "getEyeLeftBottom()"
|
||||
nameWithType: "FaceLandmarks.getEyeLeftBottom()"
|
||||
summary: "Get the eye<wbr>Left<wbr>Bottom property: The coordinates of the left eye bottom."
|
||||
syntax: "public LandmarkCoordinate getEyeLeftBottom()"
|
||||
desc: "Get the eyeLeftBottom property: The coordinates of the left eye bottom."
|
||||
returns:
|
||||
description: "the eyeLeftBottom value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeLeftInner()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeLeftInner()"
|
||||
name: "getEyeLeftInner()"
|
||||
nameWithType: "FaceLandmarks.getEyeLeftInner()"
|
||||
summary: "Get the eye<wbr>Left<wbr>Inner property: The coordinates of the left eye inner."
|
||||
syntax: "public LandmarkCoordinate getEyeLeftInner()"
|
||||
desc: "Get the eyeLeftInner property: The coordinates of the left eye inner."
|
||||
returns:
|
||||
description: "the eyeLeftInner value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeLeftOuter()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeLeftOuter()"
|
||||
name: "getEyeLeftOuter()"
|
||||
nameWithType: "FaceLandmarks.getEyeLeftOuter()"
|
||||
summary: "Get the eye<wbr>Left<wbr>Outer property: The coordinates of the left eye outer."
|
||||
syntax: "public LandmarkCoordinate getEyeLeftOuter()"
|
||||
desc: "Get the eyeLeftOuter property: The coordinates of the left eye outer."
|
||||
returns:
|
||||
description: "the eyeLeftOuter value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeLeftTop()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeLeftTop()"
|
||||
name: "getEyeLeftTop()"
|
||||
nameWithType: "FaceLandmarks.getEyeLeftTop()"
|
||||
summary: "Get the eye<wbr>Left<wbr>Top property: The coordinates of the left eye top."
|
||||
syntax: "public LandmarkCoordinate getEyeLeftTop()"
|
||||
desc: "Get the eyeLeftTop property: The coordinates of the left eye top."
|
||||
returns:
|
||||
description: "the eyeLeftTop value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeRightBottom()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeRightBottom()"
|
||||
name: "getEyeRightBottom()"
|
||||
nameWithType: "FaceLandmarks.getEyeRightBottom()"
|
||||
summary: "Get the eye<wbr>Right<wbr>Bottom property: The coordinates of the right eye bottom."
|
||||
syntax: "public LandmarkCoordinate getEyeRightBottom()"
|
||||
desc: "Get the eyeRightBottom property: The coordinates of the right eye bottom."
|
||||
returns:
|
||||
description: "the eyeRightBottom value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeRightInner()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeRightInner()"
|
||||
name: "getEyeRightInner()"
|
||||
nameWithType: "FaceLandmarks.getEyeRightInner()"
|
||||
summary: "Get the eye<wbr>Right<wbr>Inner property: The coordinates of the right eye inner."
|
||||
syntax: "public LandmarkCoordinate getEyeRightInner()"
|
||||
desc: "Get the eyeRightInner property: The coordinates of the right eye inner."
|
||||
returns:
|
||||
description: "the eyeRightInner value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeRightOuter()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeRightOuter()"
|
||||
name: "getEyeRightOuter()"
|
||||
nameWithType: "FaceLandmarks.getEyeRightOuter()"
|
||||
summary: "Get the eye<wbr>Right<wbr>Outer property: The coordinates of the right eye outer."
|
||||
syntax: "public LandmarkCoordinate getEyeRightOuter()"
|
||||
desc: "Get the eyeRightOuter property: The coordinates of the right eye outer."
|
||||
returns:
|
||||
description: "the eyeRightOuter value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeRightTop()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyeRightTop()"
|
||||
name: "getEyeRightTop()"
|
||||
nameWithType: "FaceLandmarks.getEyeRightTop()"
|
||||
summary: "Get the eye<wbr>Right<wbr>Top property: The coordinates of the right eye top."
|
||||
syntax: "public LandmarkCoordinate getEyeRightTop()"
|
||||
desc: "Get the eyeRightTop property: The coordinates of the right eye top."
|
||||
returns:
|
||||
description: "the eyeRightTop value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyebrowLeftInner()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyebrowLeftInner()"
|
||||
name: "getEyebrowLeftInner()"
|
||||
nameWithType: "FaceLandmarks.getEyebrowLeftInner()"
|
||||
summary: "Get the eyebrow<wbr>Left<wbr>Inner property: The coordinates of the left eyebrow inner."
|
||||
syntax: "public LandmarkCoordinate getEyebrowLeftInner()"
|
||||
desc: "Get the eyebrowLeftInner property: The coordinates of the left eyebrow inner."
|
||||
returns:
|
||||
description: "the eyebrowLeftInner value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyebrowLeftOuter()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyebrowLeftOuter()"
|
||||
name: "getEyebrowLeftOuter()"
|
||||
nameWithType: "FaceLandmarks.getEyebrowLeftOuter()"
|
||||
summary: "Get the eyebrow<wbr>Left<wbr>Outer property: The coordinates of the left eyebrow outer."
|
||||
syntax: "public LandmarkCoordinate getEyebrowLeftOuter()"
|
||||
desc: "Get the eyebrowLeftOuter property: The coordinates of the left eyebrow outer."
|
||||
returns:
|
||||
description: "the eyebrowLeftOuter value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyebrowRightInner()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyebrowRightInner()"
|
||||
name: "getEyebrowRightInner()"
|
||||
nameWithType: "FaceLandmarks.getEyebrowRightInner()"
|
||||
summary: "Get the eyebrow<wbr>Right<wbr>Inner property: The coordinates of the right eyebrow inner."
|
||||
syntax: "public LandmarkCoordinate getEyebrowRightInner()"
|
||||
desc: "Get the eyebrowRightInner property: The coordinates of the right eyebrow inner."
|
||||
returns:
|
||||
description: "the eyebrowRightInner value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getEyebrowRightOuter()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getEyebrowRightOuter()"
|
||||
name: "getEyebrowRightOuter()"
|
||||
nameWithType: "FaceLandmarks.getEyebrowRightOuter()"
|
||||
summary: "Get the eyebrow<wbr>Right<wbr>Outer property: The coordinates of the right eyebrow outer."
|
||||
syntax: "public LandmarkCoordinate getEyebrowRightOuter()"
|
||||
desc: "Get the eyebrowRightOuter property: The coordinates of the right eyebrow outer."
|
||||
returns:
|
||||
description: "the eyebrowRightOuter value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getMouthLeft()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getMouthLeft()"
|
||||
name: "getMouthLeft()"
|
||||
nameWithType: "FaceLandmarks.getMouthLeft()"
|
||||
summary: "Get the mouth<wbr>Left property: The coordinates of the mouth left."
|
||||
syntax: "public LandmarkCoordinate getMouthLeft()"
|
||||
desc: "Get the mouthLeft property: The coordinates of the mouth left."
|
||||
returns:
|
||||
description: "the mouthLeft value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getMouthRight()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getMouthRight()"
|
||||
name: "getMouthRight()"
|
||||
nameWithType: "FaceLandmarks.getMouthRight()"
|
||||
summary: "Get the mouth<wbr>Right property: The coordinates of the mouth right."
|
||||
syntax: "public LandmarkCoordinate getMouthRight()"
|
||||
desc: "Get the mouthRight property: The coordinates of the mouth right."
|
||||
returns:
|
||||
description: "the mouthRight value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseLeftAlarOutTip()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseLeftAlarOutTip()"
|
||||
name: "getNoseLeftAlarOutTip()"
|
||||
nameWithType: "FaceLandmarks.getNoseLeftAlarOutTip()"
|
||||
summary: "Get the nose<wbr>Left<wbr>Alar<wbr>Out<wbr>Tip property: The coordinates of the nose left alar out tip."
|
||||
syntax: "public LandmarkCoordinate getNoseLeftAlarOutTip()"
|
||||
desc: "Get the noseLeftAlarOutTip property: The coordinates of the nose left alar out tip."
|
||||
returns:
|
||||
description: "the noseLeftAlarOutTip value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseLeftAlarTop()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseLeftAlarTop()"
|
||||
name: "getNoseLeftAlarTop()"
|
||||
nameWithType: "FaceLandmarks.getNoseLeftAlarTop()"
|
||||
summary: "Get the nose<wbr>Left<wbr>Alar<wbr>Top property: The coordinates of the nose left alar top."
|
||||
syntax: "public LandmarkCoordinate getNoseLeftAlarTop()"
|
||||
desc: "Get the noseLeftAlarTop property: The coordinates of the nose left alar top."
|
||||
returns:
|
||||
description: "the noseLeftAlarTop value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseRightAlarOutTip()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseRightAlarOutTip()"
|
||||
name: "getNoseRightAlarOutTip()"
|
||||
nameWithType: "FaceLandmarks.getNoseRightAlarOutTip()"
|
||||
summary: "Get the nose<wbr>Right<wbr>Alar<wbr>Out<wbr>Tip property: The coordinates of the nose right alar out tip."
|
||||
syntax: "public LandmarkCoordinate getNoseRightAlarOutTip()"
|
||||
desc: "Get the noseRightAlarOutTip property: The coordinates of the nose right alar out tip."
|
||||
returns:
|
||||
description: "the noseRightAlarOutTip value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseRightAlarTop()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseRightAlarTop()"
|
||||
name: "getNoseRightAlarTop()"
|
||||
nameWithType: "FaceLandmarks.getNoseRightAlarTop()"
|
||||
summary: "Get the nose<wbr>Right<wbr>Alar<wbr>Top property: The coordinates of the nose right alar top."
|
||||
syntax: "public LandmarkCoordinate getNoseRightAlarTop()"
|
||||
desc: "Get the noseRightAlarTop property: The coordinates of the nose right alar top."
|
||||
returns:
|
||||
description: "the noseRightAlarTop value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseRootLeft()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseRootLeft()"
|
||||
name: "getNoseRootLeft()"
|
||||
nameWithType: "FaceLandmarks.getNoseRootLeft()"
|
||||
summary: "Get the nose<wbr>Root<wbr>Left property: The coordinates of the nose root left."
|
||||
syntax: "public LandmarkCoordinate getNoseRootLeft()"
|
||||
desc: "Get the noseRootLeft property: The coordinates of the nose root left."
|
||||
returns:
|
||||
description: "the noseRootLeft value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseRootRight()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseRootRight()"
|
||||
name: "getNoseRootRight()"
|
||||
nameWithType: "FaceLandmarks.getNoseRootRight()"
|
||||
summary: "Get the nose<wbr>Root<wbr>Right property: The coordinates of the nose root right."
|
||||
syntax: "public LandmarkCoordinate getNoseRootRight()"
|
||||
desc: "Get the noseRootRight property: The coordinates of the nose root right."
|
||||
returns:
|
||||
description: "the noseRootRight value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseTip()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getNoseTip()"
|
||||
name: "getNoseTip()"
|
||||
nameWithType: "FaceLandmarks.getNoseTip()"
|
||||
summary: "Get the nose<wbr>Tip property: The coordinates of the nose tip."
|
||||
syntax: "public LandmarkCoordinate getNoseTip()"
|
||||
desc: "Get the noseTip property: The coordinates of the nose tip."
|
||||
returns:
|
||||
description: "the noseTip value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getPupilLeft()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getPupilLeft()"
|
||||
name: "getPupilLeft()"
|
||||
nameWithType: "FaceLandmarks.getPupilLeft()"
|
||||
summary: "Get the pupil<wbr>Left property: The coordinates of the left eye pupil."
|
||||
syntax: "public LandmarkCoordinate getPupilLeft()"
|
||||
desc: "Get the pupilLeft property: The coordinates of the left eye pupil."
|
||||
returns:
|
||||
description: "the pupilLeft value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getPupilRight()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getPupilRight()"
|
||||
name: "getPupilRight()"
|
||||
nameWithType: "FaceLandmarks.getPupilRight()"
|
||||
summary: "Get the pupil<wbr>Right property: The coordinates of the right eye pupil."
|
||||
syntax: "public LandmarkCoordinate getPupilRight()"
|
||||
desc: "Get the pupilRight property: The coordinates of the right eye pupil."
|
||||
returns:
|
||||
description: "the pupilRight value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getUnderLipBottom()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getUnderLipBottom()"
|
||||
name: "getUnderLipBottom()"
|
||||
nameWithType: "FaceLandmarks.getUnderLipBottom()"
|
||||
summary: "Get the under<wbr>Lip<wbr>Bottom property: The coordinates of the under lip bottom."
|
||||
syntax: "public LandmarkCoordinate getUnderLipBottom()"
|
||||
desc: "Get the underLipBottom property: The coordinates of the under lip bottom."
|
||||
returns:
|
||||
description: "the underLipBottom value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getUnderLipTop()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getUnderLipTop()"
|
||||
name: "getUnderLipTop()"
|
||||
nameWithType: "FaceLandmarks.getUnderLipTop()"
|
||||
summary: "Get the under<wbr>Lip<wbr>Top property: The coordinates of the under lip top."
|
||||
syntax: "public LandmarkCoordinate getUnderLipTop()"
|
||||
desc: "Get the underLipTop property: The coordinates of the under lip top."
|
||||
returns:
|
||||
description: "the underLipTop value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getUpperLipBottom()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getUpperLipBottom()"
|
||||
name: "getUpperLipBottom()"
|
||||
nameWithType: "FaceLandmarks.getUpperLipBottom()"
|
||||
summary: "Get the upper<wbr>Lip<wbr>Bottom property: The coordinates of the upper lip bottom."
|
||||
syntax: "public LandmarkCoordinate getUpperLipBottom()"
|
||||
desc: "Get the upperLipBottom property: The coordinates of the upper lip bottom."
|
||||
returns:
|
||||
description: "the upperLipBottom value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLandmarks.getUpperLipTop()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLandmarks.getUpperLipTop()"
|
||||
name: "getUpperLipTop()"
|
||||
nameWithType: "FaceLandmarks.getUpperLipTop()"
|
||||
summary: "Get the upper<wbr>Lip<wbr>Top property: The coordinates of the upper lip top."
|
||||
syntax: "public LandmarkCoordinate getUpperLipTop()"
|
||||
desc: "Get the upperLipTop property: The coordinates of the upper lip top."
|
||||
returns:
|
||||
description: "the upperLipTop value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LandmarkCoordinate?alt=com.azure.ai.vision.face.models.LandmarkCoordinate&text=LandmarkCoordinate\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A collection of 27-point face landmarks pointing to the important positions of face components."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceLivenessDecision"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLivenessDecision"
|
||||
name: "FaceLivenessDecision"
|
||||
nameWithType: "FaceLivenessDecision"
|
||||
summary: "The outcome of the liveness classification."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceLivenessDecision**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.FaceLivenessDecision?alt=com.azure.ai.vision.face.models.FaceLivenessDecision&text=FaceLivenessDecision\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLivenessDecision.FaceLivenessDecision()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLivenessDecision.FaceLivenessDecision()"
|
||||
name: "FaceLivenessDecision()"
|
||||
nameWithType: "FaceLivenessDecision.FaceLivenessDecision()"
|
||||
summary: "Creates a new instance of Face<wbr>Liveness<wbr>Decision value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.FaceLivenessDecision.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public FaceLivenessDecision()"
|
||||
desc: "Creates a new instance of FaceLivenessDecision value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLivenessDecision.REAL_FACE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLivenessDecision.REAL_FACE"
|
||||
name: "REAL_FACE"
|
||||
nameWithType: "FaceLivenessDecision.REAL_FACE"
|
||||
summary: "The algorithm has classified the target face as real."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceLivenessDecision?alt=com.azure.ai.vision.face.models.FaceLivenessDecision&text=FaceLivenessDecision\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceLivenessDecision REAL_FACE"
|
||||
desc: "The algorithm has classified the target face as real."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLivenessDecision.SPOOF_FACE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLivenessDecision.SPOOF_FACE"
|
||||
name: "SPOOF_FACE"
|
||||
nameWithType: "FaceLivenessDecision.SPOOF_FACE"
|
||||
summary: "The algorithm has classified the target face as a spoof."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceLivenessDecision?alt=com.azure.ai.vision.face.models.FaceLivenessDecision&text=FaceLivenessDecision\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceLivenessDecision SPOOF_FACE"
|
||||
desc: "The algorithm has classified the target face as a spoof."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLivenessDecision.UNCERTAIN"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLivenessDecision.UNCERTAIN"
|
||||
name: "UNCERTAIN"
|
||||
nameWithType: "FaceLivenessDecision.UNCERTAIN"
|
||||
summary: "The algorithm could not classify the target face as either real or spoof."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceLivenessDecision?alt=com.azure.ai.vision.face.models.FaceLivenessDecision&text=FaceLivenessDecision\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceLivenessDecision UNCERTAIN"
|
||||
desc: "The algorithm could not classify the target face as either real or spoof."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLivenessDecision.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLivenessDecision.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "FaceLivenessDecision.fromString(String name)"
|
||||
summary: "Creates or finds a Face<wbr>Liveness<wbr>Decision from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FaceLivenessDecision fromString(String name)"
|
||||
desc: "Creates or finds a FaceLivenessDecision from its string representation."
|
||||
returns:
|
||||
description: "the corresponding FaceLivenessDecision."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceLivenessDecision?alt=com.azure.ai.vision.face.models.FaceLivenessDecision&text=FaceLivenessDecision\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceLivenessDecision.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceLivenessDecision.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FaceLivenessDecision.values()"
|
||||
summary: "Gets known Face<wbr>Liveness<wbr>Decision values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<FaceLivenessDecision> values()"
|
||||
desc: "Gets known FaceLivenessDecision values."
|
||||
returns:
|
||||
description: "known FaceLivenessDecision values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.FaceLivenessDecision?alt=com.azure.ai.vision.face.models.FaceLivenessDecision&text=FaceLivenessDecision\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "The outcome of the liveness classification."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,121 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceRecognitionModel"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRecognitionModel"
|
||||
name: "FaceRecognitionModel"
|
||||
nameWithType: "FaceRecognitionModel"
|
||||
summary: "The recognition model for the face."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceRecognitionModel**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRecognitionModel.FaceRecognitionModel()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRecognitionModel.FaceRecognitionModel()"
|
||||
name: "FaceRecognitionModel()"
|
||||
nameWithType: "FaceRecognitionModel.FaceRecognitionModel()"
|
||||
summary: "Creates a new instance of Face<wbr>Recognition<wbr>Model value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.FaceRecognitionModel.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public FaceRecognitionModel()"
|
||||
desc: "Creates a new instance of FaceRecognitionModel value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRecognitionModel.RECOGNITION_01"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRecognitionModel.RECOGNITION_01"
|
||||
name: "RECOGNITION_01"
|
||||
nameWithType: "FaceRecognitionModel.RECOGNITION_01"
|
||||
summary: "The default recognition model for \"Detect\"."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceRecognitionModel RECOGNITION_01"
|
||||
desc: "The default recognition model for \"Detect\". All those faceIds created before 2019 March are bonded with this recognition model."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRecognitionModel.RECOGNITION_02"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRecognitionModel.RECOGNITION_02"
|
||||
name: "RECOGNITION_02"
|
||||
nameWithType: "FaceRecognitionModel.RECOGNITION_02"
|
||||
summary: "Recognition model released in 2019 March."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceRecognitionModel RECOGNITION_02"
|
||||
desc: "Recognition model released in 2019 March."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRecognitionModel.RECOGNITION_03"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRecognitionModel.RECOGNITION_03"
|
||||
name: "RECOGNITION_03"
|
||||
nameWithType: "FaceRecognitionModel.RECOGNITION_03"
|
||||
summary: "Recognition model released in 2020 May."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceRecognitionModel RECOGNITION_03"
|
||||
desc: "Recognition model released in 2020 May."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRecognitionModel.RECOGNITION_04"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRecognitionModel.RECOGNITION_04"
|
||||
name: "RECOGNITION_04"
|
||||
nameWithType: "FaceRecognitionModel.RECOGNITION_04"
|
||||
summary: "Recognition model released in 2021 February."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceRecognitionModel RECOGNITION_04"
|
||||
desc: "Recognition model released in 2021 February. It's recommended to use this recognition model for better recognition accuracy."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRecognitionModel.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRecognitionModel.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "FaceRecognitionModel.fromString(String name)"
|
||||
summary: "Creates or finds a Face<wbr>Recognition<wbr>Model from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FaceRecognitionModel fromString(String name)"
|
||||
desc: "Creates or finds a FaceRecognitionModel from its string representation."
|
||||
returns:
|
||||
description: "the corresponding FaceRecognitionModel."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRecognitionModel.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRecognitionModel.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FaceRecognitionModel.values()"
|
||||
summary: "Gets known Face<wbr>Recognition<wbr>Model values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<FaceRecognitionModel> values()"
|
||||
desc: "Gets known FaceRecognitionModel values."
|
||||
returns:
|
||||
description: "known FaceRecognitionModel values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.FaceRecognitionModel?alt=com.azure.ai.vision.face.models.FaceRecognitionModel&text=FaceRecognitionModel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "The recognition model for the face."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceRectangle"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRectangle"
|
||||
name: "FaceRectangle"
|
||||
nameWithType: "FaceRectangle"
|
||||
summary: "A rectangle within which a face can be found."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceRectangle**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRectangle.getHeight()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRectangle.getHeight()"
|
||||
name: "getHeight()"
|
||||
nameWithType: "FaceRectangle.getHeight()"
|
||||
summary: "Get the height property: The height of the rectangle, in pixels."
|
||||
syntax: "public int getHeight()"
|
||||
desc: "Get the height property: The height of the rectangle, in pixels."
|
||||
returns:
|
||||
description: "the height value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRectangle.getLeft()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRectangle.getLeft()"
|
||||
name: "getLeft()"
|
||||
nameWithType: "FaceRectangle.getLeft()"
|
||||
summary: "Get the left property: The distance from the left edge if the image to the left edge of the rectangle, in pixels."
|
||||
syntax: "public int getLeft()"
|
||||
desc: "Get the left property: The distance from the left edge if the image to the left edge of the rectangle, in pixels."
|
||||
returns:
|
||||
description: "the left value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRectangle.getTop()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRectangle.getTop()"
|
||||
name: "getTop()"
|
||||
nameWithType: "FaceRectangle.getTop()"
|
||||
summary: "Get the top property: The distance from the top edge if the image to the top edge of the rectangle, in pixels."
|
||||
syntax: "public int getTop()"
|
||||
desc: "Get the top property: The distance from the top edge if the image to the top edge of the rectangle, in pixels."
|
||||
returns:
|
||||
description: "the top value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceRectangle.getWidth()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceRectangle.getWidth()"
|
||||
name: "getWidth()"
|
||||
nameWithType: "FaceRectangle.getWidth()"
|
||||
summary: "Get the width property: The width of the rectangle, in pixels."
|
||||
syntax: "public int getWidth()"
|
||||
desc: "Get the width property: The width of the rectangle, in pixels."
|
||||
returns:
|
||||
description: "the width value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A rectangle within which a face can be found."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceSessionStatus"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceSessionStatus"
|
||||
name: "FaceSessionStatus"
|
||||
nameWithType: "FaceSessionStatus"
|
||||
summary: "The current status of the session."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceSessionStatus**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.FaceSessionStatus?alt=com.azure.ai.vision.face.models.FaceSessionStatus&text=FaceSessionStatus\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceSessionStatus.FaceSessionStatus()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceSessionStatus.FaceSessionStatus()"
|
||||
name: "FaceSessionStatus()"
|
||||
nameWithType: "FaceSessionStatus.FaceSessionStatus()"
|
||||
summary: "Creates a new instance of Face<wbr>Session<wbr>Status value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.FaceSessionStatus.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public FaceSessionStatus()"
|
||||
desc: "Creates a new instance of FaceSessionStatus value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceSessionStatus.NOT_STARTED"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceSessionStatus.NOT_STARTED"
|
||||
name: "NOT_STARTED"
|
||||
nameWithType: "FaceSessionStatus.NOT_STARTED"
|
||||
summary: "Session has not started."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceSessionStatus?alt=com.azure.ai.vision.face.models.FaceSessionStatus&text=FaceSessionStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceSessionStatus NOT_STARTED"
|
||||
desc: "Session has not started."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceSessionStatus.RESULT_AVAILABLE"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceSessionStatus.RESULT_AVAILABLE"
|
||||
name: "RESULT_AVAILABLE"
|
||||
nameWithType: "FaceSessionStatus.RESULT_AVAILABLE"
|
||||
summary: "Session has available result."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceSessionStatus?alt=com.azure.ai.vision.face.models.FaceSessionStatus&text=FaceSessionStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceSessionStatus RESULT_AVAILABLE"
|
||||
desc: "Session has available result."
|
||||
- uid: "com.azure.ai.vision.face.models.FaceSessionStatus.STARTED"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceSessionStatus.STARTED"
|
||||
name: "STARTED"
|
||||
nameWithType: "FaceSessionStatus.STARTED"
|
||||
summary: "Session has started."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceSessionStatus?alt=com.azure.ai.vision.face.models.FaceSessionStatus&text=FaceSessionStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FaceSessionStatus STARTED"
|
||||
desc: "Session has started."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceSessionStatus.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceSessionStatus.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "FaceSessionStatus.fromString(String name)"
|
||||
summary: "Creates or finds a Face<wbr>Session<wbr>Status from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FaceSessionStatus fromString(String name)"
|
||||
desc: "Creates or finds a FaceSessionStatus from its string representation."
|
||||
returns:
|
||||
description: "the corresponding FaceSessionStatus."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceSessionStatus?alt=com.azure.ai.vision.face.models.FaceSessionStatus&text=FaceSessionStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceSessionStatus.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceSessionStatus.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FaceSessionStatus.values()"
|
||||
summary: "Gets known Face<wbr>Session<wbr>Status values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<FaceSessionStatus> values()"
|
||||
desc: "Gets known FaceSessionStatus values."
|
||||
returns:
|
||||
description: "known FaceSessionStatus values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.FaceSessionStatus?alt=com.azure.ai.vision.face.models.FaceSessionStatus&text=FaceSessionStatus\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "The current status of the session."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FaceVerificationResult"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceVerificationResult"
|
||||
name: "FaceVerificationResult"
|
||||
nameWithType: "FaceVerificationResult"
|
||||
summary: "Verify result."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FaceVerificationResult**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FaceVerificationResult.getConfidence()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceVerificationResult.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "FaceVerificationResult.getConfidence()"
|
||||
summary: "Get the confidence property: A number indicates the similarity confidence of whether two faces belong to the same person, or whether the face belongs to the person."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: A number indicates the similarity confidence of whether two faces belong to the same person, or whether the face belongs to the person. By default, isIdentical is set to True if similarity confidence is greater than or equal to 0.5. This is useful for advanced users to override 'isIdentical' and fine-tune the result on their own data."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FaceVerificationResult.isIdentical()"
|
||||
fullName: "com.azure.ai.vision.face.models.FaceVerificationResult.isIdentical()"
|
||||
name: "isIdentical()"
|
||||
nameWithType: "FaceVerificationResult.isIdentical()"
|
||||
summary: "Get the is<wbr>Identical property: True if the two faces belong to the same person or the face belongs to the person, otherwise false."
|
||||
syntax: "public boolean isIdentical()"
|
||||
desc: "Get the isIdentical property: True if the two faces belong to the same person or the face belongs to the person, otherwise false."
|
||||
returns:
|
||||
description: "the isIdentical value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Verify result."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FacialHair"
|
||||
fullName: "com.azure.ai.vision.face.models.FacialHair"
|
||||
name: "FacialHair"
|
||||
nameWithType: "FacialHair"
|
||||
summary: "Properties describing facial hair attributes."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FacialHair**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FacialHair.getBeard()"
|
||||
fullName: "com.azure.ai.vision.face.models.FacialHair.getBeard()"
|
||||
name: "getBeard()"
|
||||
nameWithType: "FacialHair.getBeard()"
|
||||
summary: "Get the beard property: A number ranging from 0 to 1 indicating a level of confidence associated with a property."
|
||||
syntax: "public double getBeard()"
|
||||
desc: "Get the beard property: A number ranging from 0 to 1 indicating a level of confidence associated with a property."
|
||||
returns:
|
||||
description: "the beard value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FacialHair.getMoustache()"
|
||||
fullName: "com.azure.ai.vision.face.models.FacialHair.getMoustache()"
|
||||
name: "getMoustache()"
|
||||
nameWithType: "FacialHair.getMoustache()"
|
||||
summary: "Get the moustache property: A number ranging from 0 to 1 indicating a level of confidence associated with a property."
|
||||
syntax: "public double getMoustache()"
|
||||
desc: "Get the moustache property: A number ranging from 0 to 1 indicating a level of confidence associated with a property."
|
||||
returns:
|
||||
description: "the moustache value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FacialHair.getSideburns()"
|
||||
fullName: "com.azure.ai.vision.face.models.FacialHair.getSideburns()"
|
||||
name: "getSideburns()"
|
||||
nameWithType: "FacialHair.getSideburns()"
|
||||
summary: "Get the sideburns property: A number ranging from 0 to 1 indicating a level of confidence associated with a property."
|
||||
syntax: "public double getSideburns()"
|
||||
desc: "Get the sideburns property: A number ranging from 0 to 1 indicating a level of confidence associated with a property."
|
||||
returns:
|
||||
description: "the sideburns value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Properties describing facial hair attributes."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.FindSimilarMatchMode"
|
||||
fullName: "com.azure.ai.vision.face.models.FindSimilarMatchMode"
|
||||
name: "FindSimilarMatchMode"
|
||||
nameWithType: "FindSimilarMatchMode"
|
||||
summary: "Similar face searching mode."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FindSimilarMatchMode**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.FindSimilarMatchMode?alt=com.azure.ai.vision.face.models.FindSimilarMatchMode&text=FindSimilarMatchMode\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.FindSimilarMatchMode.FindSimilarMatchMode()"
|
||||
fullName: "com.azure.ai.vision.face.models.FindSimilarMatchMode.FindSimilarMatchMode()"
|
||||
name: "FindSimilarMatchMode()"
|
||||
nameWithType: "FindSimilarMatchMode.FindSimilarMatchMode()"
|
||||
summary: "Creates a new instance of Find<wbr>Similar<wbr>Match<wbr>Mode value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.FindSimilarMatchMode.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public FindSimilarMatchMode()"
|
||||
desc: "Creates a new instance of FindSimilarMatchMode value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.FindSimilarMatchMode.MATCH_FACE"
|
||||
fullName: "com.azure.ai.vision.face.models.FindSimilarMatchMode.MATCH_FACE"
|
||||
name: "MATCH_FACE"
|
||||
nameWithType: "FindSimilarMatchMode.MATCH_FACE"
|
||||
summary: "Match face."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FindSimilarMatchMode?alt=com.azure.ai.vision.face.models.FindSimilarMatchMode&text=FindSimilarMatchMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FindSimilarMatchMode MATCH_FACE"
|
||||
desc: "Match face."
|
||||
- uid: "com.azure.ai.vision.face.models.FindSimilarMatchMode.MATCH_PERSON"
|
||||
fullName: "com.azure.ai.vision.face.models.FindSimilarMatchMode.MATCH_PERSON"
|
||||
name: "MATCH_PERSON"
|
||||
nameWithType: "FindSimilarMatchMode.MATCH_PERSON"
|
||||
summary: "Match person."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FindSimilarMatchMode?alt=com.azure.ai.vision.face.models.FindSimilarMatchMode&text=FindSimilarMatchMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FindSimilarMatchMode MATCH_PERSON"
|
||||
desc: "Match person."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.FindSimilarMatchMode.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.FindSimilarMatchMode.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "FindSimilarMatchMode.fromString(String name)"
|
||||
summary: "Creates or finds a Find<wbr>Similar<wbr>Match<wbr>Mode from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FindSimilarMatchMode fromString(String name)"
|
||||
desc: "Creates or finds a FindSimilarMatchMode from its string representation."
|
||||
returns:
|
||||
description: "the corresponding FindSimilarMatchMode."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FindSimilarMatchMode?alt=com.azure.ai.vision.face.models.FindSimilarMatchMode&text=FindSimilarMatchMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.FindSimilarMatchMode.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.FindSimilarMatchMode.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FindSimilarMatchMode.values()"
|
||||
summary: "Gets known Find<wbr>Similar<wbr>Match<wbr>Mode values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<FindSimilarMatchMode> values()"
|
||||
desc: "Gets known FindSimilarMatchMode values."
|
||||
returns:
|
||||
description: "known FindSimilarMatchMode values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.FindSimilarMatchMode?alt=com.azure.ai.vision.face.models.FindSimilarMatchMode&text=FindSimilarMatchMode\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Similar face searching mode."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,121 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.GlassesType"
|
||||
fullName: "com.azure.ai.vision.face.models.GlassesType"
|
||||
name: "GlassesType"
|
||||
nameWithType: "GlassesType"
|
||||
summary: "Glasses type of the face."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **GlassesType**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.GlassesType?alt=com.azure.ai.vision.face.models.GlassesType&text=GlassesType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.GlassesType.GlassesType()"
|
||||
fullName: "com.azure.ai.vision.face.models.GlassesType.GlassesType()"
|
||||
name: "GlassesType()"
|
||||
nameWithType: "GlassesType.GlassesType()"
|
||||
summary: "Creates a new instance of Glasses<wbr>Type value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.GlassesType.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public GlassesType()"
|
||||
desc: "Creates a new instance of GlassesType value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.GlassesType.NO_GLASSES"
|
||||
fullName: "com.azure.ai.vision.face.models.GlassesType.NO_GLASSES"
|
||||
name: "NO_GLASSES"
|
||||
nameWithType: "GlassesType.NO_GLASSES"
|
||||
summary: "No glasses on the face."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.GlassesType?alt=com.azure.ai.vision.face.models.GlassesType&text=GlassesType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final GlassesType NO_GLASSES"
|
||||
desc: "No glasses on the face."
|
||||
- uid: "com.azure.ai.vision.face.models.GlassesType.READING_GLASSES"
|
||||
fullName: "com.azure.ai.vision.face.models.GlassesType.READING_GLASSES"
|
||||
name: "READING_GLASSES"
|
||||
nameWithType: "GlassesType.READING_GLASSES"
|
||||
summary: "Normal glasses on the face."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.GlassesType?alt=com.azure.ai.vision.face.models.GlassesType&text=GlassesType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final GlassesType READING_GLASSES"
|
||||
desc: "Normal glasses on the face."
|
||||
- uid: "com.azure.ai.vision.face.models.GlassesType.SUNGLASSES"
|
||||
fullName: "com.azure.ai.vision.face.models.GlassesType.SUNGLASSES"
|
||||
name: "SUNGLASSES"
|
||||
nameWithType: "GlassesType.SUNGLASSES"
|
||||
summary: "Sunglasses on the face."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.GlassesType?alt=com.azure.ai.vision.face.models.GlassesType&text=GlassesType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final GlassesType SUNGLASSES"
|
||||
desc: "Sunglasses on the face."
|
||||
- uid: "com.azure.ai.vision.face.models.GlassesType.SWIMMING_GOGGLES"
|
||||
fullName: "com.azure.ai.vision.face.models.GlassesType.SWIMMING_GOGGLES"
|
||||
name: "SWIMMING_GOGGLES"
|
||||
nameWithType: "GlassesType.SWIMMING_GOGGLES"
|
||||
summary: "Swimming goggles on the face."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.GlassesType?alt=com.azure.ai.vision.face.models.GlassesType&text=GlassesType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final GlassesType SWIMMING_GOGGLES"
|
||||
desc: "Swimming goggles on the face."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.GlassesType.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.GlassesType.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "GlassesType.fromString(String name)"
|
||||
summary: "Creates or finds a Glasses<wbr>Type from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static GlassesType fromString(String name)"
|
||||
desc: "Creates or finds a GlassesType from its string representation."
|
||||
returns:
|
||||
description: "the corresponding GlassesType."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.GlassesType?alt=com.azure.ai.vision.face.models.GlassesType&text=GlassesType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.GlassesType.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.GlassesType.values()"
|
||||
name: "values()"
|
||||
nameWithType: "GlassesType.values()"
|
||||
summary: "Gets known Glasses<wbr>Type values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<GlassesType> values()"
|
||||
desc: "Gets known GlassesType values."
|
||||
returns:
|
||||
description: "known GlassesType values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.GlassesType?alt=com.azure.ai.vision.face.models.GlassesType&text=GlassesType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Glasses type of the face."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.HairColor"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColor"
|
||||
name: "HairColor"
|
||||
nameWithType: "HairColor"
|
||||
summary: "An array of candidate colors and confidence level in the presence of each."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **HairColor**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.HairColor.getColor()"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColor.getColor()"
|
||||
name: "getColor()"
|
||||
nameWithType: "HairColor.getColor()"
|
||||
summary: "Get the color property: Name of the hair color."
|
||||
syntax: "public HairColorType getColor()"
|
||||
desc: "Get the color property: Name of the hair color."
|
||||
returns:
|
||||
description: "the color value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.HairColor.getConfidence()"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColor.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "HairColor.getConfidence()"
|
||||
summary: "Get the confidence property: Confidence level of the color."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: Confidence level of the color. Range between \\[0,1\\]."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "An array of candidate colors and confidence level in the presence of each."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,169 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.HairColorType"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType"
|
||||
name: "HairColorType"
|
||||
nameWithType: "HairColorType"
|
||||
summary: "Name of the hair color."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **HairColorType**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.HairColorType()"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.HairColorType()"
|
||||
name: "HairColorType()"
|
||||
nameWithType: "HairColorType.HairColorType()"
|
||||
summary: "Creates a new instance of Hair<wbr>Color<wbr>Type value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.HairColorType.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public HairColorType()"
|
||||
desc: "Creates a new instance of HairColorType value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.BLACK"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.BLACK"
|
||||
name: "BLACK"
|
||||
nameWithType: "HairColorType.BLACK"
|
||||
summary: "Black."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final HairColorType BLACK"
|
||||
desc: "Black."
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.BLOND"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.BLOND"
|
||||
name: "BLOND"
|
||||
nameWithType: "HairColorType.BLOND"
|
||||
summary: "Blond."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final HairColorType BLOND"
|
||||
desc: "Blond."
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.BROWN"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.BROWN"
|
||||
name: "BROWN"
|
||||
nameWithType: "HairColorType.BROWN"
|
||||
summary: "Brown."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final HairColorType BROWN"
|
||||
desc: "Brown."
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.GRAY"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.GRAY"
|
||||
name: "GRAY"
|
||||
nameWithType: "HairColorType.GRAY"
|
||||
summary: "Gray."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final HairColorType GRAY"
|
||||
desc: "Gray."
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.OTHER"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.OTHER"
|
||||
name: "OTHER"
|
||||
nameWithType: "HairColorType.OTHER"
|
||||
summary: "Other."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final HairColorType OTHER"
|
||||
desc: "Other."
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.RED"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.RED"
|
||||
name: "RED"
|
||||
nameWithType: "HairColorType.RED"
|
||||
summary: "Red."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final HairColorType RED"
|
||||
desc: "Red."
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.UNKNOWN_HAIR_COLOR"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.UNKNOWN_HAIR_COLOR"
|
||||
name: "UNKNOWN_HAIR_COLOR"
|
||||
nameWithType: "HairColorType.UNKNOWN_HAIR_COLOR"
|
||||
summary: "Unknown."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final HairColorType UNKNOWN_HAIR_COLOR"
|
||||
desc: "Unknown."
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.WHITE"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.WHITE"
|
||||
name: "WHITE"
|
||||
nameWithType: "HairColorType.WHITE"
|
||||
summary: "White."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final HairColorType WHITE"
|
||||
desc: "White."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "HairColorType.fromString(String name)"
|
||||
summary: "Creates or finds a Hair<wbr>Color<wbr>Type from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static HairColorType fromString(String name)"
|
||||
desc: "Creates or finds a HairColorType from its string representation."
|
||||
returns:
|
||||
description: "the corresponding HairColorType."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.HairColorType.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.HairColorType.values()"
|
||||
name: "values()"
|
||||
nameWithType: "HairColorType.values()"
|
||||
summary: "Gets known Hair<wbr>Color<wbr>Type values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<HairColorType> values()"
|
||||
desc: "Gets known HairColorType values."
|
||||
returns:
|
||||
description: "known HairColorType values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.HairColorType?alt=com.azure.ai.vision.face.models.HairColorType&text=HairColorType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Name of the hair color."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.HairProperties"
|
||||
fullName: "com.azure.ai.vision.face.models.HairProperties"
|
||||
name: "HairProperties"
|
||||
nameWithType: "HairProperties"
|
||||
summary: "Properties describing hair attributes."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **HairProperties**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.HairProperties.getBald()"
|
||||
fullName: "com.azure.ai.vision.face.models.HairProperties.getBald()"
|
||||
name: "getBald()"
|
||||
nameWithType: "HairProperties.getBald()"
|
||||
summary: "Get the bald property: A number describing confidence level of whether the person is bald."
|
||||
syntax: "public double getBald()"
|
||||
desc: "Get the bald property: A number describing confidence level of whether the person is bald."
|
||||
returns:
|
||||
description: "the bald value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.HairProperties.getHairColor()"
|
||||
fullName: "com.azure.ai.vision.face.models.HairProperties.getHairColor()"
|
||||
name: "getHairColor()"
|
||||
nameWithType: "HairProperties.getHairColor()"
|
||||
summary: "Get the hair<wbr>Color property: An array of candidate colors and confidence level in the presence of each."
|
||||
syntax: "public List<HairColor> getHairColor()"
|
||||
desc: "Get the hairColor property: An array of candidate colors and confidence level in the presence of each."
|
||||
returns:
|
||||
description: "the hairColor value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.face.models.HairColor?alt=com.azure.ai.vision.face.models.HairColor&text=HairColor\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.face.models.HairProperties.isInvisible()"
|
||||
fullName: "com.azure.ai.vision.face.models.HairProperties.isInvisible()"
|
||||
name: "isInvisible()"
|
||||
nameWithType: "HairProperties.isInvisible()"
|
||||
summary: "Get the invisible property: A boolean value describing whether the hair is visible in the image."
|
||||
syntax: "public boolean isInvisible()"
|
||||
desc: "Get the invisible property: A boolean value describing whether the hair is visible in the image."
|
||||
returns:
|
||||
description: "the invisible value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Properties describing hair attributes."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.HeadPose"
|
||||
fullName: "com.azure.ai.vision.face.models.HeadPose"
|
||||
name: "HeadPose"
|
||||
nameWithType: "HeadPose"
|
||||
summary: "3-D roll/yaw/pitch angles for face direction."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **HeadPose**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.HeadPose.getPitch()"
|
||||
fullName: "com.azure.ai.vision.face.models.HeadPose.getPitch()"
|
||||
name: "getPitch()"
|
||||
nameWithType: "HeadPose.getPitch()"
|
||||
summary: "Get the pitch property: Value of angles."
|
||||
syntax: "public double getPitch()"
|
||||
desc: "Get the pitch property: Value of angles."
|
||||
returns:
|
||||
description: "the pitch value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.HeadPose.getRoll()"
|
||||
fullName: "com.azure.ai.vision.face.models.HeadPose.getRoll()"
|
||||
name: "getRoll()"
|
||||
nameWithType: "HeadPose.getRoll()"
|
||||
summary: "Get the roll property: Value of angles."
|
||||
syntax: "public double getRoll()"
|
||||
desc: "Get the roll property: Value of angles."
|
||||
returns:
|
||||
description: "the roll value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.HeadPose.getYaw()"
|
||||
fullName: "com.azure.ai.vision.face.models.HeadPose.getYaw()"
|
||||
name: "getYaw()"
|
||||
nameWithType: "HeadPose.getYaw()"
|
||||
summary: "Get the yaw property: Value of angles."
|
||||
syntax: "public double getYaw()"
|
||||
desc: "Get the yaw property: Value of angles."
|
||||
returns:
|
||||
description: "the yaw value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "3-D roll/yaw/pitch angles for face direction."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LandmarkCoordinate"
|
||||
fullName: "com.azure.ai.vision.face.models.LandmarkCoordinate"
|
||||
name: "LandmarkCoordinate"
|
||||
nameWithType: "LandmarkCoordinate"
|
||||
summary: "Landmark coordinates within an image."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LandmarkCoordinate**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LandmarkCoordinate.getX()"
|
||||
fullName: "com.azure.ai.vision.face.models.LandmarkCoordinate.getX()"
|
||||
name: "getX()"
|
||||
nameWithType: "LandmarkCoordinate.getX()"
|
||||
summary: "Get the x property: The horizontal component, in pixels."
|
||||
syntax: "public double getX()"
|
||||
desc: "Get the x property: The horizontal component, in pixels."
|
||||
returns:
|
||||
description: "the x value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LandmarkCoordinate.getY()"
|
||||
fullName: "com.azure.ai.vision.face.models.LandmarkCoordinate.getY()"
|
||||
name: "getY()"
|
||||
nameWithType: "LandmarkCoordinate.getY()"
|
||||
summary: "Get the y property: The vertical component, in pixels."
|
||||
syntax: "public double getY()"
|
||||
desc: "Get the y property: The vertical component, in pixels."
|
||||
returns:
|
||||
description: "the y value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Landmark coordinates within an image."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,121 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessModel"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessModel"
|
||||
name: "LivenessModel"
|
||||
nameWithType: "LivenessModel"
|
||||
summary: "The model version used for liveness classification."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessModel**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.LivenessModel?alt=com.azure.ai.vision.face.models.LivenessModel&text=LivenessModel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessModel.LivenessModel()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessModel.LivenessModel()"
|
||||
name: "LivenessModel()"
|
||||
nameWithType: "LivenessModel.LivenessModel()"
|
||||
summary: "Creates a new instance of Liveness<wbr>Model value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.LivenessModel.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public LivenessModel()"
|
||||
desc: "Creates a new instance of LivenessModel value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessModel.V2020_02_15_PREVIEW_01"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessModel.V2020_02_15_PREVIEW_01"
|
||||
name: "V2020_02_15_PREVIEW_01"
|
||||
nameWithType: "LivenessModel.V2020_02_15_PREVIEW_01"
|
||||
summary: "Static value 2020-02-15-preview.01 for Liveness<wbr>Model."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessModel?alt=com.azure.ai.vision.face.models.LivenessModel&text=LivenessModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LivenessModel V2020_02_15_PREVIEW_01"
|
||||
desc: "Static value 2020-02-15-preview.01 for LivenessModel."
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessModel.V2021_11_12_PREVIEW_03"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessModel.V2021_11_12_PREVIEW_03"
|
||||
name: "V2021_11_12_PREVIEW_03"
|
||||
nameWithType: "LivenessModel.V2021_11_12_PREVIEW_03"
|
||||
summary: "Static value 2021-11-12-preview.03 for Liveness<wbr>Model."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessModel?alt=com.azure.ai.vision.face.models.LivenessModel&text=LivenessModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LivenessModel V2021_11_12_PREVIEW_03"
|
||||
desc: "Static value 2021-11-12-preview.03 for LivenessModel."
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessModel.V2022_10_15_PREVIEW_04"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessModel.V2022_10_15_PREVIEW_04"
|
||||
name: "V2022_10_15_PREVIEW_04"
|
||||
nameWithType: "LivenessModel.V2022_10_15_PREVIEW_04"
|
||||
summary: "Static value 2022-10-15-preview.04 for Liveness<wbr>Model."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessModel?alt=com.azure.ai.vision.face.models.LivenessModel&text=LivenessModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LivenessModel V2022_10_15_PREVIEW_04"
|
||||
desc: "Static value 2022-10-15-preview.04 for LivenessModel."
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessModel.V2023_03_02_PREVIEW_05"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessModel.V2023_03_02_PREVIEW_05"
|
||||
name: "V2023_03_02_PREVIEW_05"
|
||||
nameWithType: "LivenessModel.V2023_03_02_PREVIEW_05"
|
||||
summary: "Static value 2023-03-02-preview.05 for Liveness<wbr>Model."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessModel?alt=com.azure.ai.vision.face.models.LivenessModel&text=LivenessModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LivenessModel V2023_03_02_PREVIEW_05"
|
||||
desc: "Static value 2023-03-02-preview.05 for LivenessModel."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessModel.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessModel.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "LivenessModel.fromString(String name)"
|
||||
summary: "Creates or finds a Liveness<wbr>Model from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static LivenessModel fromString(String name)"
|
||||
desc: "Creates or finds a LivenessModel from its string representation."
|
||||
returns:
|
||||
description: "the corresponding LivenessModel."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessModel?alt=com.azure.ai.vision.face.models.LivenessModel&text=LivenessModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessModel.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessModel.values()"
|
||||
name: "values()"
|
||||
nameWithType: "LivenessModel.values()"
|
||||
summary: "Gets known Liveness<wbr>Model values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<LivenessModel> values()"
|
||||
desc: "Gets known LivenessModel values."
|
||||
returns:
|
||||
description: "known LivenessModel values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.LivenessModel?alt=com.azure.ai.vision.face.models.LivenessModel&text=LivenessModel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "The model version used for liveness classification."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessOperationMode"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOperationMode"
|
||||
name: "LivenessOperationMode"
|
||||
nameWithType: "LivenessOperationMode"
|
||||
summary: "The liveness operation mode to drive the client\\\\u2019s end-user experience."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessOperationMode**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.LivenessOperationMode?alt=com.azure.ai.vision.face.models.LivenessOperationMode&text=LivenessOperationMode\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessOperationMode.LivenessOperationMode()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOperationMode.LivenessOperationMode()"
|
||||
name: "LivenessOperationMode()"
|
||||
nameWithType: "LivenessOperationMode.LivenessOperationMode()"
|
||||
summary: "Creates a new instance of Liveness<wbr>Operation<wbr>Mode value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.LivenessOperationMode.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public LivenessOperationMode()"
|
||||
desc: "Creates a new instance of LivenessOperationMode value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessOperationMode.PASSIVE"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOperationMode.PASSIVE"
|
||||
name: "PASSIVE"
|
||||
nameWithType: "LivenessOperationMode.PASSIVE"
|
||||
summary: "Utilizes a passive liveness technique that requires no additional actions from the user."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessOperationMode?alt=com.azure.ai.vision.face.models.LivenessOperationMode&text=LivenessOperationMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LivenessOperationMode PASSIVE"
|
||||
desc: "Utilizes a passive liveness technique that requires no additional actions from the user. Requires normal indoor lighting and high screen brightness for optimal performance. And thus, this mode has a narrow operational envelope and will not be suitable for scenarios that requires the end-user\\\\u2019s to be in bright lighting conditions. Note: this is the only supported mode for the Mobile (iOS and Android) solution."
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessOperationMode.PASSIVE_ACTIVE"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOperationMode.PASSIVE_ACTIVE"
|
||||
name: "PASSIVE_ACTIVE"
|
||||
nameWithType: "LivenessOperationMode.PASSIVE_ACTIVE"
|
||||
summary: "This mode utilizes a hybrid passive or active liveness technique that necessitates user cooperation."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessOperationMode?alt=com.azure.ai.vision.face.models.LivenessOperationMode&text=LivenessOperationMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LivenessOperationMode PASSIVE_ACTIVE"
|
||||
desc: "This mode utilizes a hybrid passive or active liveness technique that necessitates user cooperation. It is optimized to require active motion only under suboptimal lighting conditions. Unlike the passive mode, this mode has no lighting restrictions, and thus offering a broader operational envelope. This mode is preferable on Web based solutions due to the lack of automatic screen brightness control available on browsers which hinders the Passive mode\\\\u2019s operational envelope on Web based solutions."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessOperationMode.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOperationMode.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "LivenessOperationMode.fromString(String name)"
|
||||
summary: "Creates or finds a Liveness<wbr>Operation<wbr>Mode from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static LivenessOperationMode fromString(String name)"
|
||||
desc: "Creates or finds a LivenessOperationMode from its string representation."
|
||||
returns:
|
||||
description: "the corresponding LivenessOperationMode."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessOperationMode?alt=com.azure.ai.vision.face.models.LivenessOperationMode&text=LivenessOperationMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessOperationMode.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOperationMode.values()"
|
||||
name: "values()"
|
||||
nameWithType: "LivenessOperationMode.values()"
|
||||
summary: "Gets known Liveness<wbr>Operation<wbr>Mode values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<LivenessOperationMode> values()"
|
||||
desc: "Gets known LivenessOperationMode values."
|
||||
returns:
|
||||
description: "known LivenessOperationMode values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.LivenessOperationMode?alt=com.azure.ai.vision.face.models.LivenessOperationMode&text=LivenessOperationMode\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "The liveness operation mode to drive the client\\\\u2019s end-user experience."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessOutputsTarget"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOutputsTarget"
|
||||
name: "LivenessOutputsTarget"
|
||||
nameWithType: "LivenessOutputsTarget"
|
||||
summary: "The liveness classification for target face."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessOutputsTarget**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessOutputsTarget.getFaceRectangle()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOutputsTarget.getFaceRectangle()"
|
||||
name: "getFaceRectangle()"
|
||||
nameWithType: "LivenessOutputsTarget.getFaceRectangle()"
|
||||
summary: "Get the face<wbr>Rectangle property: The face region where the liveness classification was made on."
|
||||
syntax: "public FaceRectangle getFaceRectangle()"
|
||||
desc: "Get the faceRectangle property: The face region where the liveness classification was made on."
|
||||
returns:
|
||||
description: "the faceRectangle value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRectangle?alt=com.azure.ai.vision.face.models.FaceRectangle&text=FaceRectangle\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessOutputsTarget.getFileName()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOutputsTarget.getFileName()"
|
||||
name: "getFileName()"
|
||||
nameWithType: "LivenessOutputsTarget.getFileName()"
|
||||
summary: "Get the file<wbr>Name property: The file name which contains the face rectangle where the liveness classification was made on."
|
||||
syntax: "public String getFileName()"
|
||||
desc: "Get the fileName property: The file name which contains the face rectangle where the liveness classification was made on."
|
||||
returns:
|
||||
description: "the fileName value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessOutputsTarget.getImageType()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOutputsTarget.getImageType()"
|
||||
name: "getImageType()"
|
||||
nameWithType: "LivenessOutputsTarget.getImageType()"
|
||||
summary: "Get the image<wbr>Type property: The image type which contains the face rectangle where the liveness classification was made on."
|
||||
syntax: "public FaceImageType getImageType()"
|
||||
desc: "Get the imageType property: The image type which contains the face rectangle where the liveness classification was made on."
|
||||
returns:
|
||||
description: "the imageType value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceImageType?alt=com.azure.ai.vision.face.models.FaceImageType&text=FaceImageType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessOutputsTarget.getTimeOffsetWithinFile()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessOutputsTarget.getTimeOffsetWithinFile()"
|
||||
name: "getTimeOffsetWithinFile()"
|
||||
nameWithType: "LivenessOutputsTarget.getTimeOffsetWithinFile()"
|
||||
summary: "Get the time<wbr>Offset<wbr>Within<wbr>File property: The time offset within the file of the frame which contains the face rectangle where the liveness classification was made on."
|
||||
syntax: "public int getTimeOffsetWithinFile()"
|
||||
desc: "Get the timeOffsetWithinFile property: The time offset within the file of the frame which contains the face rectangle where the liveness classification was made on."
|
||||
returns:
|
||||
description: "the timeOffsetWithinFile value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "The liveness classification for target face."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessResponseBody"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessResponseBody"
|
||||
name: "LivenessResponseBody"
|
||||
nameWithType: "LivenessResponseBody"
|
||||
summary: "The response body of detect liveness API call."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessResponseBody**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessResponseBody.getAdditionalProperties()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessResponseBody.getAdditionalProperties()"
|
||||
name: "getAdditionalProperties()"
|
||||
nameWithType: "LivenessResponseBody.getAdditionalProperties()"
|
||||
summary: "Get the additional<wbr>Properties property: The response body of detect liveness API call."
|
||||
syntax: "public Map<String,Object> getAdditionalProperties()"
|
||||
desc: "Get the additionalProperties property: The response body of detect liveness API call. Additional properties."
|
||||
returns:
|
||||
description: "the additionalProperties value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessResponseBody.getLivenessDecision()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessResponseBody.getLivenessDecision()"
|
||||
name: "getLivenessDecision()"
|
||||
nameWithType: "LivenessResponseBody.getLivenessDecision()"
|
||||
summary: "Get the liveness<wbr>Decision property: The liveness classification for the target face."
|
||||
syntax: "public FaceLivenessDecision getLivenessDecision()"
|
||||
desc: "Get the livenessDecision property: The liveness classification for the target face."
|
||||
returns:
|
||||
description: "the livenessDecision value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceLivenessDecision?alt=com.azure.ai.vision.face.models.FaceLivenessDecision&text=FaceLivenessDecision\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessResponseBody.getModelVersionUsed()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessResponseBody.getModelVersionUsed()"
|
||||
name: "getModelVersionUsed()"
|
||||
nameWithType: "LivenessResponseBody.getModelVersionUsed()"
|
||||
summary: "Get the model<wbr>Version<wbr>Used property: The model version used for liveness classification."
|
||||
syntax: "public LivenessModel getModelVersionUsed()"
|
||||
desc: "Get the modelVersionUsed property: The model version used for liveness classification."
|
||||
returns:
|
||||
description: "the modelVersionUsed value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessModel?alt=com.azure.ai.vision.face.models.LivenessModel&text=LivenessModel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessResponseBody.getTarget()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessResponseBody.getTarget()"
|
||||
name: "getTarget()"
|
||||
nameWithType: "LivenessResponseBody.getTarget()"
|
||||
summary: "Get the target property: Specific targets used for liveness classification."
|
||||
syntax: "public LivenessOutputsTarget getTarget()"
|
||||
desc: "Get the target property: Specific targets used for liveness classification."
|
||||
returns:
|
||||
description: "the target value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessOutputsTarget?alt=com.azure.ai.vision.face.models.LivenessOutputsTarget&text=LivenessOutputsTarget\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessResponseBody.getVerifyResult()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessResponseBody.getVerifyResult()"
|
||||
name: "getVerifyResult()"
|
||||
nameWithType: "LivenessResponseBody.getVerifyResult()"
|
||||
summary: "Get the verify<wbr>Result property: The face verification output."
|
||||
syntax: "public LivenessWithVerifyOutputs getVerifyResult()"
|
||||
desc: "Get the verifyResult property: The face verification output. Only available when the request is liveness with verify."
|
||||
returns:
|
||||
description: "the verifyResult value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessWithVerifyOutputs?alt=com.azure.ai.vision.face.models.LivenessWithVerifyOutputs&text=LivenessWithVerifyOutputs\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "The response body of detect liveness API call."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessSession"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSession"
|
||||
name: "LivenessSession"
|
||||
nameWithType: "LivenessSession"
|
||||
summary: "Session result of detect liveness."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessSession**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSession.getAuthTokenTimeToLiveInSeconds()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSession.getAuthTokenTimeToLiveInSeconds()"
|
||||
name: "getAuthTokenTimeToLiveInSeconds()"
|
||||
nameWithType: "LivenessSession.getAuthTokenTimeToLiveInSeconds()"
|
||||
summary: "Get the auth<wbr>Token<wbr>Time<wbr>ToLive<wbr>InSeconds property: Seconds the session should last for."
|
||||
syntax: "public Integer getAuthTokenTimeToLiveInSeconds()"
|
||||
desc: "Get the authTokenTimeToLiveInSeconds property: Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600."
|
||||
returns:
|
||||
description: "the authTokenTimeToLiveInSeconds value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSession.getCreatedDateTime()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSession.getCreatedDateTime()"
|
||||
name: "getCreatedDateTime()"
|
||||
nameWithType: "LivenessSession.getCreatedDateTime()"
|
||||
summary: "Get the created<wbr>Date<wbr>Time property: Date<wbr>Time when this session was created."
|
||||
syntax: "public OffsetDateTime getCreatedDateTime()"
|
||||
desc: "Get the createdDateTime property: DateTime when this session was created."
|
||||
returns:
|
||||
description: "the createdDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSession.getDeviceCorrelationId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSession.getDeviceCorrelationId()"
|
||||
name: "getDeviceCorrelationId()"
|
||||
nameWithType: "LivenessSession.getDeviceCorrelationId()"
|
||||
summary: "Get the device<wbr>Correlation<wbr>Id property: Unique Guid per each end-user device."
|
||||
syntax: "public String getDeviceCorrelationId()"
|
||||
desc: "Get the deviceCorrelationId property: Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null."
|
||||
returns:
|
||||
description: "the deviceCorrelationId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSession.getId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSession.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "LivenessSession.getId()"
|
||||
summary: "Get the id property: The unique ID to reference this session."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: The unique ID to reference this session."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSession.getResult()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSession.getResult()"
|
||||
name: "getResult()"
|
||||
nameWithType: "LivenessSession.getResult()"
|
||||
summary: "Get the result property: The latest session audit result only populated if status == 'Result<wbr>Available'."
|
||||
syntax: "public LivenessSessionAuditEntry getResult()"
|
||||
desc: "Get the result property: The latest session audit result only populated if status == 'ResultAvailable'."
|
||||
returns:
|
||||
description: "the result value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSession.getSessionStartDateTime()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSession.getSessionStartDateTime()"
|
||||
name: "getSessionStartDateTime()"
|
||||
nameWithType: "LivenessSession.getSessionStartDateTime()"
|
||||
summary: "Get the session<wbr>Start<wbr>Date<wbr>Time property: Date<wbr>Time when this session was started by the client."
|
||||
syntax: "public OffsetDateTime getSessionStartDateTime()"
|
||||
desc: "Get the sessionStartDateTime property: DateTime when this session was started by the client."
|
||||
returns:
|
||||
description: "the sessionStartDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSession.getStatus()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSession.getStatus()"
|
||||
name: "getStatus()"
|
||||
nameWithType: "LivenessSession.getStatus()"
|
||||
summary: "Get the status property: The current status of the session."
|
||||
syntax: "public FaceSessionStatus getStatus()"
|
||||
desc: "Get the status property: The current status of the session."
|
||||
returns:
|
||||
description: "the status value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceSessionStatus?alt=com.azure.ai.vision.face.models.FaceSessionStatus&text=FaceSessionStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSession.isSessionExpired()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSession.isSessionExpired()"
|
||||
name: "isSessionExpired()"
|
||||
nameWithType: "LivenessSession.isSessionExpired()"
|
||||
summary: "Get the session<wbr>Expired property: Whether or not the session is expired."
|
||||
syntax: "public boolean isSessionExpired()"
|
||||
desc: "Get the sessionExpired property: Whether or not the session is expired."
|
||||
returns:
|
||||
description: "the sessionExpired value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Session result of detect liveness."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry"
|
||||
name: "LivenessSessionAuditEntry"
|
||||
nameWithType: "LivenessSessionAuditEntry"
|
||||
summary: "Audit entry for a request in session."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessSessionAuditEntry**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getClientRequestId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getClientRequestId()"
|
||||
name: "getClientRequestId()"
|
||||
nameWithType: "LivenessSessionAuditEntry.getClientRequestId()"
|
||||
summary: "Get the client<wbr>Request<wbr>Id property: The unique client<wbr>Request<wbr>Id that is sent by the client in the 'client-request-id' header."
|
||||
syntax: "public String getClientRequestId()"
|
||||
desc: "Get the clientRequestId property: The unique clientRequestId that is sent by the client in the 'client-request-id' header."
|
||||
returns:
|
||||
description: "the clientRequestId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getDigest()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getDigest()"
|
||||
name: "getDigest()"
|
||||
nameWithType: "LivenessSessionAuditEntry.getDigest()"
|
||||
summary: "Get the digest property: The server calculated digest for this request."
|
||||
syntax: "public String getDigest()"
|
||||
desc: "Get the digest property: The server calculated digest for this request. If the client reported digest differs from the server calculated digest, then the message integrity between the client and service has been compromised and the result should not be trusted. For more information, see how to guides on how to leverage this value to secure your end-to-end solution."
|
||||
returns:
|
||||
description: "the digest value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "LivenessSessionAuditEntry.getId()"
|
||||
summary: "Get the id property: The unique id to refer to this audit request."
|
||||
syntax: "public long getId()"
|
||||
desc: "Get the id property: The unique id to refer to this audit request. Use this id with the 'start' query parameter to continue on to the next page of audit results."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getReceivedDateTime()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getReceivedDateTime()"
|
||||
name: "getReceivedDateTime()"
|
||||
nameWithType: "LivenessSessionAuditEntry.getReceivedDateTime()"
|
||||
summary: "Get the received<wbr>Date<wbr>Time property: The UTC Date<wbr>Time that the request was received."
|
||||
syntax: "public OffsetDateTime getReceivedDateTime()"
|
||||
desc: "Get the receivedDateTime property: The UTC DateTime that the request was received."
|
||||
returns:
|
||||
description: "the receivedDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getRequest()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getRequest()"
|
||||
name: "getRequest()"
|
||||
nameWithType: "LivenessSessionAuditEntry.getRequest()"
|
||||
summary: "Get the request property: The request of this entry."
|
||||
syntax: "public AuditRequestInfo getRequest()"
|
||||
desc: "Get the request property: The request of this entry."
|
||||
returns:
|
||||
description: "the request value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.AuditRequestInfo?alt=com.azure.ai.vision.face.models.AuditRequestInfo&text=AuditRequestInfo\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getRequestId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getRequestId()"
|
||||
name: "getRequestId()"
|
||||
nameWithType: "LivenessSessionAuditEntry.getRequestId()"
|
||||
summary: "Get the request<wbr>Id property: The unique request<wbr>Id that is returned by the service to the client in the 'apim-request-id' header."
|
||||
syntax: "public String getRequestId()"
|
||||
desc: "Get the requestId property: The unique requestId that is returned by the service to the client in the 'apim-request-id' header."
|
||||
returns:
|
||||
description: "the requestId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getResponse()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getResponse()"
|
||||
name: "getResponse()"
|
||||
nameWithType: "LivenessSessionAuditEntry.getResponse()"
|
||||
summary: "Get the response property: The response of this entry."
|
||||
syntax: "public AuditLivenessResponseInfo getResponse()"
|
||||
desc: "Get the response property: The response of this entry."
|
||||
returns:
|
||||
description: "the response value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.AuditLivenessResponseInfo?alt=com.azure.ai.vision.face.models.AuditLivenessResponseInfo&text=AuditLivenessResponseInfo\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getSessionId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionAuditEntry.getSessionId()"
|
||||
name: "getSessionId()"
|
||||
nameWithType: "LivenessSessionAuditEntry.getSessionId()"
|
||||
summary: "Get the session<wbr>Id property: The unique session<wbr>Id of the created session."
|
||||
syntax: "public String getSessionId()"
|
||||
desc: "Get the sessionId property: The unique sessionId of the created session. It will expire 48 hours after it was created or may be deleted sooner using the corresponding session DELETE operation."
|
||||
returns:
|
||||
description: "the sessionId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Audit entry for a request in session."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,89 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessSessionItem"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionItem"
|
||||
name: "LivenessSessionItem"
|
||||
nameWithType: "LivenessSessionItem"
|
||||
summary: "Session data returned for enumeration."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessSessionItem**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionItem.getAuthTokenTimeToLiveInSeconds()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionItem.getAuthTokenTimeToLiveInSeconds()"
|
||||
name: "getAuthTokenTimeToLiveInSeconds()"
|
||||
nameWithType: "LivenessSessionItem.getAuthTokenTimeToLiveInSeconds()"
|
||||
summary: "Get the auth<wbr>Token<wbr>Time<wbr>ToLive<wbr>InSeconds property: Seconds the session should last for."
|
||||
syntax: "public Integer getAuthTokenTimeToLiveInSeconds()"
|
||||
desc: "Get the authTokenTimeToLiveInSeconds property: Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600."
|
||||
returns:
|
||||
description: "the authTokenTimeToLiveInSeconds value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionItem.getCreatedDateTime()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionItem.getCreatedDateTime()"
|
||||
name: "getCreatedDateTime()"
|
||||
nameWithType: "LivenessSessionItem.getCreatedDateTime()"
|
||||
summary: "Get the created<wbr>Date<wbr>Time property: Date<wbr>Time when this session was created."
|
||||
syntax: "public OffsetDateTime getCreatedDateTime()"
|
||||
desc: "Get the createdDateTime property: DateTime when this session was created."
|
||||
returns:
|
||||
description: "the createdDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionItem.getDeviceCorrelationId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionItem.getDeviceCorrelationId()"
|
||||
name: "getDeviceCorrelationId()"
|
||||
nameWithType: "LivenessSessionItem.getDeviceCorrelationId()"
|
||||
summary: "Get the device<wbr>Correlation<wbr>Id property: Unique Guid per each end-user device."
|
||||
syntax: "public String getDeviceCorrelationId()"
|
||||
desc: "Get the deviceCorrelationId property: Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null."
|
||||
returns:
|
||||
description: "the deviceCorrelationId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionItem.getId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionItem.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "LivenessSessionItem.getId()"
|
||||
summary: "Get the id property: The unique ID to reference this session."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: The unique ID to reference this session."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionItem.getSessionStartDateTime()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionItem.getSessionStartDateTime()"
|
||||
name: "getSessionStartDateTime()"
|
||||
nameWithType: "LivenessSessionItem.getSessionStartDateTime()"
|
||||
summary: "Get the session<wbr>Start<wbr>Date<wbr>Time property: Date<wbr>Time when this session was started by the client."
|
||||
syntax: "public OffsetDateTime getSessionStartDateTime()"
|
||||
desc: "Get the sessionStartDateTime property: DateTime when this session was started by the client."
|
||||
returns:
|
||||
description: "the sessionStartDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessSessionItem.isSessionExpired()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessSessionItem.isSessionExpired()"
|
||||
name: "isSessionExpired()"
|
||||
nameWithType: "LivenessSessionItem.isSessionExpired()"
|
||||
summary: "Get the session<wbr>Expired property: Whether or not the session is expired."
|
||||
syntax: "public boolean isSessionExpired()"
|
||||
desc: "Get the sessionExpired property: Whether or not the session is expired."
|
||||
returns:
|
||||
description: "the sessionExpired value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Session data returned for enumeration."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessWithVerifyImage"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifyImage"
|
||||
name: "LivenessWithVerifyImage"
|
||||
nameWithType: "LivenessWithVerifyImage"
|
||||
summary: "The detail of face for verification."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessWithVerifyImage**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifyImage.getFaceRectangle()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifyImage.getFaceRectangle()"
|
||||
name: "getFaceRectangle()"
|
||||
nameWithType: "LivenessWithVerifyImage.getFaceRectangle()"
|
||||
summary: "Get the face<wbr>Rectangle property: The face region where the comparison image's classification was made."
|
||||
syntax: "public FaceRectangle getFaceRectangle()"
|
||||
desc: "Get the faceRectangle property: The face region where the comparison image's classification was made."
|
||||
returns:
|
||||
description: "the faceRectangle value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceRectangle?alt=com.azure.ai.vision.face.models.FaceRectangle&text=FaceRectangle\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifyImage.getQualityForRecognition()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifyImage.getQualityForRecognition()"
|
||||
name: "getQualityForRecognition()"
|
||||
nameWithType: "LivenessWithVerifyImage.getQualityForRecognition()"
|
||||
summary: "Get the quality<wbr>For<wbr>Recognition property: Quality of face image for recognition."
|
||||
syntax: "public QualityForRecognition getQualityForRecognition()"
|
||||
desc: "Get the qualityForRecognition property: Quality of face image for recognition."
|
||||
returns:
|
||||
description: "the qualityForRecognition value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.QualityForRecognition?alt=com.azure.ai.vision.face.models.QualityForRecognition&text=QualityForRecognition\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "The detail of face for verification."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessWithVerifyOutputs"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifyOutputs"
|
||||
name: "LivenessWithVerifyOutputs"
|
||||
nameWithType: "LivenessWithVerifyOutputs"
|
||||
summary: "The face verification output."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessWithVerifyOutputs**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifyOutputs.getMatchConfidence()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifyOutputs.getMatchConfidence()"
|
||||
name: "getMatchConfidence()"
|
||||
nameWithType: "LivenessWithVerifyOutputs.getMatchConfidence()"
|
||||
summary: "Get the match<wbr>Confidence property: The target face liveness face and comparison image face verification confidence."
|
||||
syntax: "public double getMatchConfidence()"
|
||||
desc: "Get the matchConfidence property: The target face liveness face and comparison image face verification confidence."
|
||||
returns:
|
||||
description: "the matchConfidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifyOutputs.getVerifyImage()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifyOutputs.getVerifyImage()"
|
||||
name: "getVerifyImage()"
|
||||
nameWithType: "LivenessWithVerifyOutputs.getVerifyImage()"
|
||||
summary: "Get the verify<wbr>Image property: The detail of face for verification."
|
||||
syntax: "public LivenessWithVerifyImage getVerifyImage()"
|
||||
desc: "Get the verifyImage property: The detail of face for verification."
|
||||
returns:
|
||||
description: "the verifyImage value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessWithVerifyImage?alt=com.azure.ai.vision.face.models.LivenessWithVerifyImage&text=LivenessWithVerifyImage\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifyOutputs.isIdentical()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifyOutputs.isIdentical()"
|
||||
name: "isIdentical()"
|
||||
nameWithType: "LivenessWithVerifyOutputs.isIdentical()"
|
||||
summary: "Get the is<wbr>Identical property: Whether the target liveness face and comparison image face match."
|
||||
syntax: "public boolean isIdentical()"
|
||||
desc: "Get the isIdentical property: Whether the target liveness face and comparison image face match."
|
||||
returns:
|
||||
description: "the isIdentical value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "The face verification output."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.LivenessWithVerifySession"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifySession"
|
||||
name: "LivenessWithVerifySession"
|
||||
nameWithType: "LivenessWithVerifySession"
|
||||
summary: "Session result of detect liveness with verify."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **LivenessWithVerifySession**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getAuthTokenTimeToLiveInSeconds()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getAuthTokenTimeToLiveInSeconds()"
|
||||
name: "getAuthTokenTimeToLiveInSeconds()"
|
||||
nameWithType: "LivenessWithVerifySession.getAuthTokenTimeToLiveInSeconds()"
|
||||
summary: "Get the auth<wbr>Token<wbr>Time<wbr>ToLive<wbr>InSeconds property: Seconds the session should last for."
|
||||
syntax: "public Integer getAuthTokenTimeToLiveInSeconds()"
|
||||
desc: "Get the authTokenTimeToLiveInSeconds property: Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600."
|
||||
returns:
|
||||
description: "the authTokenTimeToLiveInSeconds value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getCreatedDateTime()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getCreatedDateTime()"
|
||||
name: "getCreatedDateTime()"
|
||||
nameWithType: "LivenessWithVerifySession.getCreatedDateTime()"
|
||||
summary: "Get the created<wbr>Date<wbr>Time property: Date<wbr>Time when this session was created."
|
||||
syntax: "public OffsetDateTime getCreatedDateTime()"
|
||||
desc: "Get the createdDateTime property: DateTime when this session was created."
|
||||
returns:
|
||||
description: "the createdDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getDeviceCorrelationId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getDeviceCorrelationId()"
|
||||
name: "getDeviceCorrelationId()"
|
||||
nameWithType: "LivenessWithVerifySession.getDeviceCorrelationId()"
|
||||
summary: "Get the device<wbr>Correlation<wbr>Id property: Unique Guid per each end-user device."
|
||||
syntax: "public String getDeviceCorrelationId()"
|
||||
desc: "Get the deviceCorrelationId property: Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null."
|
||||
returns:
|
||||
description: "the deviceCorrelationId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getId()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "LivenessWithVerifySession.getId()"
|
||||
summary: "Get the id property: The unique ID to reference this session."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: The unique ID to reference this session."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getResult()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getResult()"
|
||||
name: "getResult()"
|
||||
nameWithType: "LivenessWithVerifySession.getResult()"
|
||||
summary: "Get the result property: The latest session audit result only populated if status == 'Result<wbr>Available'."
|
||||
syntax: "public LivenessSessionAuditEntry getResult()"
|
||||
desc: "Get the result property: The latest session audit result only populated if status == 'ResultAvailable'."
|
||||
returns:
|
||||
description: "the result value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.LivenessSessionAuditEntry?alt=com.azure.ai.vision.face.models.LivenessSessionAuditEntry&text=LivenessSessionAuditEntry\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getSessionStartDateTime()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getSessionStartDateTime()"
|
||||
name: "getSessionStartDateTime()"
|
||||
nameWithType: "LivenessWithVerifySession.getSessionStartDateTime()"
|
||||
summary: "Get the session<wbr>Start<wbr>Date<wbr>Time property: Date<wbr>Time when this session was started by the client."
|
||||
syntax: "public OffsetDateTime getSessionStartDateTime()"
|
||||
desc: "Get the sessionStartDateTime property: DateTime when this session was started by the client."
|
||||
returns:
|
||||
description: "the sessionStartDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getStatus()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifySession.getStatus()"
|
||||
name: "getStatus()"
|
||||
nameWithType: "LivenessWithVerifySession.getStatus()"
|
||||
summary: "Get the status property: The current status of the session."
|
||||
syntax: "public FaceSessionStatus getStatus()"
|
||||
desc: "Get the status property: The current status of the session."
|
||||
returns:
|
||||
description: "the status value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.FaceSessionStatus?alt=com.azure.ai.vision.face.models.FaceSessionStatus&text=FaceSessionStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.LivenessWithVerifySession.isSessionExpired()"
|
||||
fullName: "com.azure.ai.vision.face.models.LivenessWithVerifySession.isSessionExpired()"
|
||||
name: "isSessionExpired()"
|
||||
nameWithType: "LivenessWithVerifySession.isSessionExpired()"
|
||||
summary: "Get the session<wbr>Expired property: Whether or not the session is expired."
|
||||
syntax: "public boolean isSessionExpired()"
|
||||
desc: "Get the sessionExpired property: Whether or not the session is expired."
|
||||
returns:
|
||||
description: "the sessionExpired value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Session result of detect liveness with verify."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.MaskProperties"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskProperties"
|
||||
name: "MaskProperties"
|
||||
nameWithType: "MaskProperties"
|
||||
summary: "Properties describing the presence of a mask on a given face."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **MaskProperties**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.MaskProperties.getType()"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskProperties.getType()"
|
||||
name: "getType()"
|
||||
nameWithType: "MaskProperties.getType()"
|
||||
summary: "Get the type property: Type of the mask."
|
||||
syntax: "public MaskType getType()"
|
||||
desc: "Get the type property: Type of the mask."
|
||||
returns:
|
||||
description: "the type value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.MaskType?alt=com.azure.ai.vision.face.models.MaskType&text=MaskType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.MaskProperties.isNoseAndMouthCovered()"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskProperties.isNoseAndMouthCovered()"
|
||||
name: "isNoseAndMouthCovered()"
|
||||
nameWithType: "MaskProperties.isNoseAndMouthCovered()"
|
||||
summary: "Get the nose<wbr>And<wbr>Mouth<wbr>Covered property: A boolean value indicating whether nose and mouth are covered."
|
||||
syntax: "public boolean isNoseAndMouthCovered()"
|
||||
desc: "Get the noseAndMouthCovered property: A boolean value indicating whether nose and mouth are covered."
|
||||
returns:
|
||||
description: "the noseAndMouthCovered value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Properties describing the presence of a mask on a given face."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,121 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.MaskType"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskType"
|
||||
name: "MaskType"
|
||||
nameWithType: "MaskType"
|
||||
summary: "Type of the mask."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **MaskType**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.MaskType?alt=com.azure.ai.vision.face.models.MaskType&text=MaskType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.MaskType.MaskType()"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskType.MaskType()"
|
||||
name: "MaskType()"
|
||||
nameWithType: "MaskType.MaskType()"
|
||||
summary: "Creates a new instance of Mask<wbr>Type value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.MaskType.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public MaskType()"
|
||||
desc: "Creates a new instance of MaskType value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.MaskType.FACE_MASK"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskType.FACE_MASK"
|
||||
name: "FACE_MASK"
|
||||
nameWithType: "MaskType.FACE_MASK"
|
||||
summary: "Face mask."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.MaskType?alt=com.azure.ai.vision.face.models.MaskType&text=MaskType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final MaskType FACE_MASK"
|
||||
desc: "Face mask."
|
||||
- uid: "com.azure.ai.vision.face.models.MaskType.NO_MASK"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskType.NO_MASK"
|
||||
name: "NO_MASK"
|
||||
nameWithType: "MaskType.NO_MASK"
|
||||
summary: "No mask."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.MaskType?alt=com.azure.ai.vision.face.models.MaskType&text=MaskType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final MaskType NO_MASK"
|
||||
desc: "No mask."
|
||||
- uid: "com.azure.ai.vision.face.models.MaskType.OTHER_MASK_OR_OCCLUSION"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskType.OTHER_MASK_OR_OCCLUSION"
|
||||
name: "OTHER_MASK_OR_OCCLUSION"
|
||||
nameWithType: "MaskType.OTHER_MASK_OR_OCCLUSION"
|
||||
summary: "Other types of mask or occlusion."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.MaskType?alt=com.azure.ai.vision.face.models.MaskType&text=MaskType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final MaskType OTHER_MASK_OR_OCCLUSION"
|
||||
desc: "Other types of mask or occlusion."
|
||||
- uid: "com.azure.ai.vision.face.models.MaskType.UNCERTAIN"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskType.UNCERTAIN"
|
||||
name: "UNCERTAIN"
|
||||
nameWithType: "MaskType.UNCERTAIN"
|
||||
summary: "Uncertain."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.MaskType?alt=com.azure.ai.vision.face.models.MaskType&text=MaskType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final MaskType UNCERTAIN"
|
||||
desc: "Uncertain."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.MaskType.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskType.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "MaskType.fromString(String name)"
|
||||
summary: "Creates or finds a Mask<wbr>Type from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static MaskType fromString(String name)"
|
||||
desc: "Creates or finds a MaskType from its string representation."
|
||||
returns:
|
||||
description: "the corresponding MaskType."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.MaskType?alt=com.azure.ai.vision.face.models.MaskType&text=MaskType\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.MaskType.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.MaskType.values()"
|
||||
name: "values()"
|
||||
nameWithType: "MaskType.values()"
|
||||
summary: "Gets known Mask<wbr>Type values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<MaskType> values()"
|
||||
desc: "Gets known MaskType values."
|
||||
returns:
|
||||
description: "known MaskType values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.MaskType?alt=com.azure.ai.vision.face.models.MaskType&text=MaskType\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Type of the mask."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.NoiseLevel"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseLevel"
|
||||
name: "NoiseLevel"
|
||||
nameWithType: "NoiseLevel"
|
||||
summary: "Indicates level of noise."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **NoiseLevel**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.NoiseLevel?alt=com.azure.ai.vision.face.models.NoiseLevel&text=NoiseLevel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.NoiseLevel.NoiseLevel()"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseLevel.NoiseLevel()"
|
||||
name: "NoiseLevel()"
|
||||
nameWithType: "NoiseLevel.NoiseLevel()"
|
||||
summary: "Creates a new instance of Noise<wbr>Level value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.NoiseLevel.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public NoiseLevel()"
|
||||
desc: "Creates a new instance of NoiseLevel value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.NoiseLevel.HIGH"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseLevel.HIGH"
|
||||
name: "HIGH"
|
||||
nameWithType: "NoiseLevel.HIGH"
|
||||
summary: "High noise level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.NoiseLevel?alt=com.azure.ai.vision.face.models.NoiseLevel&text=NoiseLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final NoiseLevel HIGH"
|
||||
desc: "High noise level."
|
||||
- uid: "com.azure.ai.vision.face.models.NoiseLevel.LOW"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseLevel.LOW"
|
||||
name: "LOW"
|
||||
nameWithType: "NoiseLevel.LOW"
|
||||
summary: "Low noise level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.NoiseLevel?alt=com.azure.ai.vision.face.models.NoiseLevel&text=NoiseLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final NoiseLevel LOW"
|
||||
desc: "Low noise level."
|
||||
- uid: "com.azure.ai.vision.face.models.NoiseLevel.MEDIUM"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseLevel.MEDIUM"
|
||||
name: "MEDIUM"
|
||||
nameWithType: "NoiseLevel.MEDIUM"
|
||||
summary: "Medium noise level."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.NoiseLevel?alt=com.azure.ai.vision.face.models.NoiseLevel&text=NoiseLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final NoiseLevel MEDIUM"
|
||||
desc: "Medium noise level."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.NoiseLevel.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseLevel.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "NoiseLevel.fromString(String name)"
|
||||
summary: "Creates or finds a Noise<wbr>Level from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static NoiseLevel fromString(String name)"
|
||||
desc: "Creates or finds a NoiseLevel from its string representation."
|
||||
returns:
|
||||
description: "the corresponding NoiseLevel."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.NoiseLevel?alt=com.azure.ai.vision.face.models.NoiseLevel&text=NoiseLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.NoiseLevel.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseLevel.values()"
|
||||
name: "values()"
|
||||
nameWithType: "NoiseLevel.values()"
|
||||
summary: "Gets known Noise<wbr>Level values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<NoiseLevel> values()"
|
||||
desc: "Gets known NoiseLevel values."
|
||||
returns:
|
||||
description: "known NoiseLevel values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.NoiseLevel?alt=com.azure.ai.vision.face.models.NoiseLevel&text=NoiseLevel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Indicates level of noise."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.NoiseProperties"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseProperties"
|
||||
name: "NoiseProperties"
|
||||
nameWithType: "NoiseProperties"
|
||||
summary: "Properties describing noise level of the image."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **NoiseProperties**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.NoiseProperties.getNoiseLevel()"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseProperties.getNoiseLevel()"
|
||||
name: "getNoiseLevel()"
|
||||
nameWithType: "NoiseProperties.getNoiseLevel()"
|
||||
summary: "Get the noise<wbr>Level property: An enum value indicating level of noise."
|
||||
syntax: "public NoiseLevel getNoiseLevel()"
|
||||
desc: "Get the noiseLevel property: An enum value indicating level of noise."
|
||||
returns:
|
||||
description: "the noiseLevel value."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.NoiseLevel?alt=com.azure.ai.vision.face.models.NoiseLevel&text=NoiseLevel\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.NoiseProperties.getValue()"
|
||||
fullName: "com.azure.ai.vision.face.models.NoiseProperties.getValue()"
|
||||
name: "getValue()"
|
||||
nameWithType: "NoiseProperties.getValue()"
|
||||
summary: "Get the value property: A number indicating level of noise level ranging from 0 to 1."
|
||||
syntax: "public double getValue()"
|
||||
desc: "Get the value property: A number indicating level of noise level ranging from 0 to 1. \\[0, 0.25) is under exposure. \\[0.25, 0.75) is good exposure. \\[0.75, 1\\] is over exposure. \\[0, 0.3) is low noise level. \\[0.3, 0.7) is medium noise level. \\[0.7, 1\\] is high noise level."
|
||||
returns:
|
||||
description: "the value value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Properties describing noise level of the image."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.OcclusionProperties"
|
||||
fullName: "com.azure.ai.vision.face.models.OcclusionProperties"
|
||||
name: "OcclusionProperties"
|
||||
nameWithType: "OcclusionProperties"
|
||||
summary: "Properties describing occlusions on a given face."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **OcclusionProperties**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.OcclusionProperties.isEyeOccluded()"
|
||||
fullName: "com.azure.ai.vision.face.models.OcclusionProperties.isEyeOccluded()"
|
||||
name: "isEyeOccluded()"
|
||||
nameWithType: "OcclusionProperties.isEyeOccluded()"
|
||||
summary: "Get the eye<wbr>Occluded property: A boolean value indicating whether eyes are occluded."
|
||||
syntax: "public boolean isEyeOccluded()"
|
||||
desc: "Get the eyeOccluded property: A boolean value indicating whether eyes are occluded."
|
||||
returns:
|
||||
description: "the eyeOccluded value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.OcclusionProperties.isForeheadOccluded()"
|
||||
fullName: "com.azure.ai.vision.face.models.OcclusionProperties.isForeheadOccluded()"
|
||||
name: "isForeheadOccluded()"
|
||||
nameWithType: "OcclusionProperties.isForeheadOccluded()"
|
||||
summary: "Get the forehead<wbr>Occluded property: A boolean value indicating whether forehead is occluded."
|
||||
syntax: "public boolean isForeheadOccluded()"
|
||||
desc: "Get the foreheadOccluded property: A boolean value indicating whether forehead is occluded."
|
||||
returns:
|
||||
description: "the foreheadOccluded value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.OcclusionProperties.isMouthOccluded()"
|
||||
fullName: "com.azure.ai.vision.face.models.OcclusionProperties.isMouthOccluded()"
|
||||
name: "isMouthOccluded()"
|
||||
nameWithType: "OcclusionProperties.isMouthOccluded()"
|
||||
summary: "Get the mouth<wbr>Occluded property: A boolean value indicating whether the mouth is occluded."
|
||||
syntax: "public boolean isMouthOccluded()"
|
||||
desc: "Get the mouthOccluded property: A boolean value indicating whether the mouth is occluded."
|
||||
returns:
|
||||
description: "the mouthOccluded value."
|
||||
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Properties describing occlusions on a given face."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.face.models.QualityForRecognition"
|
||||
fullName: "com.azure.ai.vision.face.models.QualityForRecognition"
|
||||
name: "QualityForRecognition"
|
||||
nameWithType: "QualityForRecognition"
|
||||
summary: "Indicates quality of image for recognition."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **QualityForRecognition**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.face.models.QualityForRecognition?alt=com.azure.ai.vision.face.models.QualityForRecognition&text=QualityForRecognition\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.face.models.QualityForRecognition.QualityForRecognition()"
|
||||
fullName: "com.azure.ai.vision.face.models.QualityForRecognition.QualityForRecognition()"
|
||||
name: "QualityForRecognition()"
|
||||
nameWithType: "QualityForRecognition.QualityForRecognition()"
|
||||
summary: "Creates a new instance of Quality<wbr>For<wbr>Recognition value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.face.models.QualityForRecognition.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public QualityForRecognition()"
|
||||
desc: "Creates a new instance of QualityForRecognition value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.face.models.QualityForRecognition.HIGH"
|
||||
fullName: "com.azure.ai.vision.face.models.QualityForRecognition.HIGH"
|
||||
name: "HIGH"
|
||||
nameWithType: "QualityForRecognition.HIGH"
|
||||
summary: "High quality."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.QualityForRecognition?alt=com.azure.ai.vision.face.models.QualityForRecognition&text=QualityForRecognition\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final QualityForRecognition HIGH"
|
||||
desc: "High quality."
|
||||
- uid: "com.azure.ai.vision.face.models.QualityForRecognition.LOW"
|
||||
fullName: "com.azure.ai.vision.face.models.QualityForRecognition.LOW"
|
||||
name: "LOW"
|
||||
nameWithType: "QualityForRecognition.LOW"
|
||||
summary: "Low quality."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.QualityForRecognition?alt=com.azure.ai.vision.face.models.QualityForRecognition&text=QualityForRecognition\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final QualityForRecognition LOW"
|
||||
desc: "Low quality."
|
||||
- uid: "com.azure.ai.vision.face.models.QualityForRecognition.MEDIUM"
|
||||
fullName: "com.azure.ai.vision.face.models.QualityForRecognition.MEDIUM"
|
||||
name: "MEDIUM"
|
||||
nameWithType: "QualityForRecognition.MEDIUM"
|
||||
summary: "Medium quality."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.QualityForRecognition?alt=com.azure.ai.vision.face.models.QualityForRecognition&text=QualityForRecognition\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final QualityForRecognition MEDIUM"
|
||||
desc: "Medium quality."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.face.models.QualityForRecognition.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.face.models.QualityForRecognition.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "QualityForRecognition.fromString(String name)"
|
||||
summary: "Creates or finds a Quality<wbr>For<wbr>Recognition from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static QualityForRecognition fromString(String name)"
|
||||
desc: "Creates or finds a QualityForRecognition from its string representation."
|
||||
returns:
|
||||
description: "the corresponding QualityForRecognition."
|
||||
type: "<xref href=\"com.azure.ai.vision.face.models.QualityForRecognition?alt=com.azure.ai.vision.face.models.QualityForRecognition&text=QualityForRecognition\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.face.models.QualityForRecognition.values()"
|
||||
fullName: "com.azure.ai.vision.face.models.QualityForRecognition.values()"
|
||||
name: "values()"
|
||||
nameWithType: "QualityForRecognition.values()"
|
||||
summary: "Gets known Quality<wbr>For<wbr>Recognition values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<QualityForRecognition> values()"
|
||||
desc: "Gets known QualityForRecognition values."
|
||||
returns:
|
||||
description: "known QualityForRecognition values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.face.models.QualityForRecognition?alt=com.azure.ai.vision.face.models.QualityForRecognition&text=QualityForRecognition\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Indicates quality of image for recognition."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
### YamlMime:JavaPackage
|
||||
uid: "com.azure.ai.vision.face.models"
|
||||
fullName: "com.azure.ai.vision.face.models"
|
||||
name: "com.azure.ai.vision.face.models"
|
||||
summary: "<!-- start generated doc -->\n Package containing the data models for Face."
|
||||
classes:
|
||||
- "com.azure.ai.vision.face.models.AccessoryItem"
|
||||
- "com.azure.ai.vision.face.models.AccessoryType"
|
||||
- "com.azure.ai.vision.face.models.AuditLivenessResponseInfo"
|
||||
- "com.azure.ai.vision.face.models.AuditRequestInfo"
|
||||
- "com.azure.ai.vision.face.models.BlurLevel"
|
||||
- "com.azure.ai.vision.face.models.BlurProperties"
|
||||
- "com.azure.ai.vision.face.models.CreateLivenessSessionContent"
|
||||
- "com.azure.ai.vision.face.models.CreateLivenessSessionResult"
|
||||
- "com.azure.ai.vision.face.models.CreateLivenessWithVerifySessionResult"
|
||||
- "com.azure.ai.vision.face.models.DetectOptions"
|
||||
- "com.azure.ai.vision.face.models.ExposureLevel"
|
||||
- "com.azure.ai.vision.face.models.ExposureProperties"
|
||||
- "com.azure.ai.vision.face.models.FaceAttributeType"
|
||||
- "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection01"
|
||||
- "com.azure.ai.vision.face.models.FaceAttributeType.ModelDetection03"
|
||||
- "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition03"
|
||||
- "com.azure.ai.vision.face.models.FaceAttributeType.ModelRecognition04"
|
||||
- "com.azure.ai.vision.face.models.FaceAttributes"
|
||||
- "com.azure.ai.vision.face.models.FaceDetectionModel"
|
||||
- "com.azure.ai.vision.face.models.FaceDetectionResult"
|
||||
- "com.azure.ai.vision.face.models.FaceFindSimilarResult"
|
||||
- "com.azure.ai.vision.face.models.FaceGroupingResult"
|
||||
- "com.azure.ai.vision.face.models.FaceImageType"
|
||||
- "com.azure.ai.vision.face.models.FaceLandmarks"
|
||||
- "com.azure.ai.vision.face.models.FaceLivenessDecision"
|
||||
- "com.azure.ai.vision.face.models.FaceRecognitionModel"
|
||||
- "com.azure.ai.vision.face.models.FaceRectangle"
|
||||
- "com.azure.ai.vision.face.models.FaceSessionStatus"
|
||||
- "com.azure.ai.vision.face.models.FaceVerificationResult"
|
||||
- "com.azure.ai.vision.face.models.FacialHair"
|
||||
- "com.azure.ai.vision.face.models.FindSimilarMatchMode"
|
||||
- "com.azure.ai.vision.face.models.GlassesType"
|
||||
- "com.azure.ai.vision.face.models.HairColor"
|
||||
- "com.azure.ai.vision.face.models.HairColorType"
|
||||
- "com.azure.ai.vision.face.models.HairProperties"
|
||||
- "com.azure.ai.vision.face.models.HeadPose"
|
||||
- "com.azure.ai.vision.face.models.LandmarkCoordinate"
|
||||
- "com.azure.ai.vision.face.models.LivenessModel"
|
||||
- "com.azure.ai.vision.face.models.LivenessOperationMode"
|
||||
- "com.azure.ai.vision.face.models.LivenessOutputsTarget"
|
||||
- "com.azure.ai.vision.face.models.LivenessResponseBody"
|
||||
- "com.azure.ai.vision.face.models.LivenessSession"
|
||||
- "com.azure.ai.vision.face.models.LivenessSessionAuditEntry"
|
||||
- "com.azure.ai.vision.face.models.LivenessSessionItem"
|
||||
- "com.azure.ai.vision.face.models.LivenessWithVerifyImage"
|
||||
- "com.azure.ai.vision.face.models.LivenessWithVerifyOutputs"
|
||||
- "com.azure.ai.vision.face.models.LivenessWithVerifySession"
|
||||
- "com.azure.ai.vision.face.models.MaskProperties"
|
||||
- "com.azure.ai.vision.face.models.MaskType"
|
||||
- "com.azure.ai.vision.face.models.NoiseLevel"
|
||||
- "com.azure.ai.vision.face.models.NoiseProperties"
|
||||
- "com.azure.ai.vision.face.models.OcclusionProperties"
|
||||
- "com.azure.ai.vision.face.models.QualityForRecognition"
|
||||
desc: "<!-- start generated doc -->\n Package containing the data models for Face.\n <!-- end generated doc -->"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face.models"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
### YamlMime:JavaPackage
|
||||
uid: "com.azure.ai.vision.face"
|
||||
fullName: "com.azure.ai.vision.face"
|
||||
name: "com.azure.ai.vision.face"
|
||||
summary: "<!-- start generated doc -->\n Package containing the classes for Face."
|
||||
classes:
|
||||
- "com.azure.ai.vision.face.FaceAsyncClient"
|
||||
- "com.azure.ai.vision.face.FaceClient"
|
||||
- "com.azure.ai.vision.face.FaceClientBuilder"
|
||||
- "com.azure.ai.vision.face.FaceSessionAsyncClient"
|
||||
- "com.azure.ai.vision.face.FaceSessionClient"
|
||||
- "com.azure.ai.vision.face.FaceSessionClientBuilder"
|
||||
enums:
|
||||
- "com.azure.ai.vision.face.FaceServiceVersion"
|
||||
desc: "<!-- start generated doc -->\n Package containing the classes for Face.\n <!-- end generated doc -->"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.face"
|
||||
artifact: com.azure:azure-ai-vision-face:1.0.0-beta.1
|
||||
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче