CI Update
Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=468048&view=results
This commit is contained in:
apexvss@microsoft.com
Родитель
58e8d11c07
Коммит
59032bb111
|
|
@ -0,0 +1,115 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient"
|
||||
name: "ImageAnalysisAsyncClient"
|
||||
nameWithType: "ImageAnalysisAsyncClient"
|
||||
summary: "Initializes a new instance of the asynchronous Image<wbr>Analysis<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 **ImageAnalysisAsyncClient**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.analyze(com.azure.core.util.BinaryData,java.util.List<com.azure.ai.vision.imageanalysis.models.VisualFeatures>,com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
name: "analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
nameWithType: "ImageAnalysisAsyncClient.analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
summary: "Performs a single Image Analysis operation on a given image buffer."
|
||||
parameters:
|
||||
- description: "The image to analyze."
|
||||
name: "imageData"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "A list of visual features to analyze.\n Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\n At least one visual feature must be specified."
|
||||
name: "visualFeatures"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Additional image analysis options."
|
||||
name: "options"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<ImageAnalysisResult> analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
desc: "Performs a single Image Analysis operation on a given image buffer."
|
||||
returns:
|
||||
description: "represents the outcome of an Image Analysis operation on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>.\n\n <!-- src_embed com.azure.ai.vision.imageanalysis.async-analysis-from-file -->\n <pre>\n //\n // Asynchronous analysis of an image file (sample.jpg), using all visual features,\n // with all options set. You will likely need fewer visual features and only\n // some (or no) options set.\n //\n ImageAnalysisOptions options = new ImageAnalysisOptions()\n .setLanguage("en")\n .setGenderNeutralCaption(true)\n .setSmartCropsAspectRatios(Arrays.asList(0.9, 1.33))\n .setModelVersion("latest");\n\n Mono<ImageAnalysisResult> result = client.analyze(\n BinaryData.fromFile(new File("sample.jpg").toPath()),\n Arrays.asList(\n VisualFeatures.SMART_CROPS,\n VisualFeatures.CAPTION,\n VisualFeatures.DENSE_CAPTIONS,\n VisualFeatures.OBJECTS,\n VisualFeatures.PEOPLE,\n VisualFeatures.READ,\n VisualFeatures.TAGS),\n options);\n </pre>\n <!-- end com.azure.ai.vision.imageanalysis.async-analysis-from-file -->"
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.analyzeFromUrl(java.lang.String,java.util.List<com.azure.ai.vision.imageanalysis.models.VisualFeatures>,com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
name: "analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
nameWithType: "ImageAnalysisAsyncClient.analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
summary: "Performs a single Image Analysis operation on a give image URL."
|
||||
parameters:
|
||||
- description: "The publicly accessible URL of the image to analyze."
|
||||
name: "imageUrl"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "A list of visual features to analyze.\n Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\n At least one visual feature must be specified."
|
||||
name: "visualFeatures"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Additional image analysis options."
|
||||
name: "options"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<ImageAnalysisResult> analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
desc: "Performs a single Image Analysis operation on a give image URL."
|
||||
returns:
|
||||
description: "represents the outcome of an Image Analysis operation on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>.\n\n <!-- src_embed com.azure.ai.vision.imageanalysis.async-analysis-from-url -->\n <pre>\n //\n // Asynchronous analysis of an image file (https://aka.ms/azsdk/image-analysis/sample.jpg),\n // using all visual features, with all options set. You will likely need fewer visual features\n // and only some (or no) options set.\n //\n ImageAnalysisOptions options = new ImageAnalysisOptions()\n .setLanguage("en")\n .setGenderNeutralCaption(true)\n .setSmartCropsAspectRatios(Arrays.asList(0.9, 1.33))\n .setModelVersion("latest");\n\n Mono<ImageAnalysisResult> result = client.analyzeFromUrl(\n "https://aka.ms/azsdk/image-analysis/sample.jpg",\n Arrays.asList(\n VisualFeatures.SMART_CROPS,\n VisualFeatures.CAPTION,\n VisualFeatures.DENSE_CAPTIONS,\n VisualFeatures.OBJECTS,\n VisualFeatures.PEOPLE,\n VisualFeatures.READ,\n VisualFeatures.TAGS),\n options);\n </pre>\n <!-- end com.azure.ai.vision.imageanalysis.async-analysis-from-url -->"
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.analyzeFromUrlWithResponse(java.lang.String,java.util.List<com.azure.ai.vision.imageanalysis.models.VisualFeatures>,com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
name: "analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
nameWithType: "ImageAnalysisAsyncClient.analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
summary: "Performs a single Image Analysis operation on a give image URL, while allowing customization of the HTTP request and access to HTTP request and response details."
|
||||
parameters:
|
||||
- description: "The publicly accessible URL of the image to analyze."
|
||||
name: "imageUrl"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "A list of visual features to analyze.\n Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\n At least one visual feature must be specified."
|
||||
name: "visualFeatures"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Additional image analysis options."
|
||||
name: "imageAnalysisOptions"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before the 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<ImageAnalysisResult>> analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
desc: "Performs a single Image Analysis operation on a give image URL, while allowing customization of the HTTP request and access to HTTP request and response details. This is not commonly used."
|
||||
returns:
|
||||
description: "represents the outcome of an Image Analysis operation along with\n <a href=\"https://learn.microsoft.com/java/api/com.azure.core.http.rest.response\">Response</a>,\n 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.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.analyzeWithResponse(com.azure.core.util.BinaryData,java.util.List<com.azure.ai.vision.imageanalysis.models.VisualFeatures>,com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
name: "analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
nameWithType: "ImageAnalysisAsyncClient.analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
summary: "Performs a single Image Analysis operation on a given image buffer, while allowing customization of the HTTP request and access to HTTP request and response details."
|
||||
parameters:
|
||||
- description: "The image to analyze."
|
||||
name: "imageData"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "A list of visual features to analyze.\n Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\n At least one visual feature must be specified."
|
||||
name: "visualFeatures"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Additional image analysis options."
|
||||
name: "imageAnalysisOptions"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before the 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<ImageAnalysisResult>> analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
desc: "Performs a single Image Analysis operation on a given image buffer, while allowing customization of the HTTP request and access to HTTP request and response details. This is not commonly used."
|
||||
returns:
|
||||
description: "represents the outcome of an Image Analysis operation along with\n <a href=\"https://learn.microsoft.com/java/api/com.azure.core.http.rest.response\">Response</a>,\n 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.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
type: "class"
|
||||
desc: "Initializes a new instance of the asynchronous ImageAnalysisClient type.\n\n```java\n//\n // Create an asynchronous Image Analysis client with API key authentication.\n //\n ImageAnalysisAsyncClient client = new ImageAnalysisClientBuilder()\n .endpoint(endpoint)\n .credential(new KeyCredential(key))\n .buildAsyncClient();\n```\n\n```java\n//\n // Create an asynchronous Image Analysis client with Entra ID authentication.\n //\n ImageAnalysisAsyncClient client = new ImageAnalysisClientBuilder()\n .endpoint(endpoint)\n .credential(new DefaultAzureCredentialBuilder().build())\n .buildAsyncClient();\n```"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,115 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient"
|
||||
name: "ImageAnalysisClient"
|
||||
nameWithType: "ImageAnalysisClient"
|
||||
summary: "Initializes a new instance of the synchronous Image<wbr>Analysis<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 **ImageAnalysisClient**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient.analyze(com.azure.core.util.BinaryData,java.util.List<com.azure.ai.vision.imageanalysis.models.VisualFeatures>,com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient.analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
name: "analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
nameWithType: "ImageAnalysisClient.analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
summary: "Performs a single Image Analysis operation on a given image buffer."
|
||||
parameters:
|
||||
- description: "The image to analyze."
|
||||
name: "imageData"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "A list of visual features to analyze.\n Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\n At least one visual feature must be specified."
|
||||
name: "visualFeatures"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Additional image analysis options."
|
||||
name: "options"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public ImageAnalysisResult analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
desc: "Performs a single Image Analysis operation on a given image buffer."
|
||||
returns:
|
||||
description: "represents the outcome of an Image Analysis operation.\n\n <!-- src_embed com.azure.ai.vision.imageanalysis.sync-analysis-from-file -->\n <pre>\n //\n // Synchronous analysis of an image file (sample.jpg), using all visual features,\n // with all options set. You will likely need fewer visual features and only\n // some (or no) options set.\n //\n ImageAnalysisOptions options = new ImageAnalysisOptions()\n .setLanguage("en")\n .setGenderNeutralCaption(true)\n .setSmartCropsAspectRatios(Arrays.asList(0.9, 1.33))\n .setModelVersion("latest");\n\n ImageAnalysisResult result = client.analyze(\n BinaryData.fromFile(new File("sample.jpg").toPath()),\n Arrays.asList(\n VisualFeatures.SMART_CROPS,\n VisualFeatures.CAPTION,\n VisualFeatures.DENSE_CAPTIONS,\n VisualFeatures.OBJECTS,\n VisualFeatures.PEOPLE,\n VisualFeatures.READ,\n VisualFeatures.TAGS),\n options);\n </pre>\n <!-- end com.azure.ai.vision.imageanalysis.sync-analysis-from-file -->"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient.analyzeFromUrl(java.lang.String,java.util.List<com.azure.ai.vision.imageanalysis.models.VisualFeatures>,com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient.analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
name: "analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
nameWithType: "ImageAnalysisClient.analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
summary: "Performs a single Image Analysis operation on a give image URL."
|
||||
parameters:
|
||||
- description: "The publicly accessible URL of the image to analyze."
|
||||
name: "imageUrl"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "A list of visual features to analyze.\n Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\n At least one visual feature must be specified."
|
||||
name: "visualFeatures"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Additional image analysis options."
|
||||
name: "options"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public ImageAnalysisResult analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)"
|
||||
desc: "Performs a single Image Analysis operation on a give image URL."
|
||||
returns:
|
||||
description: "represents the outcome of an Image Analysis operation.\n\n <!-- src_embed com.azure.ai.vision.imageanalysis.sync-analysis-from-url -->\n <pre>\n //\n // Synchronous analysis of an image file (https://aka.ms/azsdk/image-analysis/sample.jpg),\n // using all visual features, with all options set. You will likely need fewer visual features\n // and only some (or no) options set.\n //\n ImageAnalysisOptions options = new ImageAnalysisOptions()\n .setLanguage("en")\n .setGenderNeutralCaption(true)\n .setSmartCropsAspectRatios(Arrays.asList(0.9, 1.33))\n .setModelVersion("latest");\n\n ImageAnalysisResult result = client.analyzeFromUrl(\n "https://aka.ms/azsdk/image-analysis/sample.jpg",\n Arrays.asList(\n VisualFeatures.SMART_CROPS,\n VisualFeatures.CAPTION,\n VisualFeatures.DENSE_CAPTIONS,\n VisualFeatures.OBJECTS,\n VisualFeatures.PEOPLE,\n VisualFeatures.READ,\n VisualFeatures.TAGS),\n options);\n </pre>\n <!-- end com.azure.ai.vision.imageanalysis.sync-analysis-from-url -->"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient.analyzeFromUrlWithResponse(java.lang.String,java.util.List<com.azure.ai.vision.imageanalysis.models.VisualFeatures>,com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient.analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
name: "analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
nameWithType: "ImageAnalysisClient.analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
summary: "Performs a single Image Analysis operation on a given image URL, while allowing customization of the HTTP request and access to HTTP request and response details."
|
||||
parameters:
|
||||
- description: "The publicly accessible URL of the image to analyze."
|
||||
name: "imageUrl"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "A list of visual features to analyze.\n Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\n At least one visual feature must be specified."
|
||||
name: "visualFeatures"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Additional image analysis options."
|
||||
name: "imageAnalysisOptions"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before the 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<ImageAnalysisResult> analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
desc: "Performs a single Image Analysis operation on a given image URL, while allowing customization of the HTTP request and access to HTTP request and response details. This is not commonly used."
|
||||
returns:
|
||||
description: "represents the outcome of an Image Analysis operation along with\n <a href=\"https://learn.microsoft.com/java/api/com.azure.core.http.rest.response\">Response</a>."
|
||||
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.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient.analyzeWithResponse(com.azure.core.util.BinaryData,java.util.List<com.azure.ai.vision.imageanalysis.models.VisualFeatures>,com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClient.analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
name: "analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
nameWithType: "ImageAnalysisClient.analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
summary: "Performs a single Image Analysis operation on a given image buffer, while allowing customization of the HTTP request and access to HTTP request and response details."
|
||||
parameters:
|
||||
- description: "The image to analyze."
|
||||
name: "imageData"
|
||||
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "A list of visual features to analyze.\n Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.\n At least one visual feature must be specified."
|
||||
name: "visualFeatures"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- description: "Additional image analysis options."
|
||||
name: "imageAnalysisOptions"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "The options to configure the HTTP request before the 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<ImageAnalysisResult> analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)"
|
||||
desc: "Performs a single Image Analysis operation on a given image buffer, while allowing customization of the HTTP request and access to HTTP request and response details. This is not commonly used."
|
||||
returns:
|
||||
description: "represents the outcome of an Image Analysis operation along with\n <a href=\"https://learn.microsoft.com/java/api/com.azure.core.http.rest.response\">Response</a>."
|
||||
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.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Initializes a new instance of the synchronous ImageAnalysisClient type.\n\n```java\n//\n // Create a synchronous Image Analysis client with API key authentication.\n //\n ImageAnalysisClient client = new ImageAnalysisClientBuilder()\n .endpoint(endpoint)\n .credential(new KeyCredential(key))\n .buildClient();\n```\n\n```java\n//\n // Create a synchronous Image Analysis client with Entra ID authentication.\n //\n ImageAnalysisClient client = new ImageAnalysisClientBuilder()\n .endpoint(endpoint)\n .credential(new DefaultAzureCredentialBuilder().build())\n .buildClient();\n```"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,211 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder"
|
||||
name: "ImageAnalysisClientBuilder"
|
||||
nameWithType: "ImageAnalysisClientBuilder"
|
||||
summary: "A builder for creating a new instance of the Image<wbr>Analysis<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 **ImageAnalysisClientBuilder**</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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" 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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" 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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" 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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" 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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.ImageAnalysisClientBuilder()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.ImageAnalysisClientBuilder()"
|
||||
name: "ImageAnalysisClientBuilder()"
|
||||
nameWithType: "ImageAnalysisClientBuilder.ImageAnalysisClientBuilder()"
|
||||
summary: "Create an instance of the Image<wbr>Analysis<wbr>Client<wbr>Builder."
|
||||
syntax: "public ImageAnalysisClientBuilder()"
|
||||
desc: "Create an instance of the ImageAnalysisClientBuilder."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.buildAsyncClient()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.buildAsyncClient()"
|
||||
name: "buildAsyncClient()"
|
||||
nameWithType: "ImageAnalysisClientBuilder.buildAsyncClient()"
|
||||
summary: "Builds an instance of Image<wbr>Analysis<wbr>Async<wbr>Client class."
|
||||
syntax: "public ImageAnalysisAsyncClient buildAsyncClient()"
|
||||
desc: "Builds an instance of ImageAnalysisAsyncClient class."
|
||||
returns:
|
||||
description: "an instance of ImageAnalysisAsyncClient."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient&text=ImageAnalysisAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.buildClient()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.buildClient()"
|
||||
name: "buildClient()"
|
||||
nameWithType: "ImageAnalysisClientBuilder.buildClient()"
|
||||
summary: "Builds an instance of Image<wbr>Analysis<wbr>Client class."
|
||||
syntax: "public ImageAnalysisClient buildClient()"
|
||||
desc: "Builds an instance of ImageAnalysisClient class."
|
||||
returns:
|
||||
description: "an instance of ImageAnalysisClient."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClient?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClient&text=ImageAnalysisClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
name: "clientOptions(ClientOptions clientOptions)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder clientOptions(ClientOptions clientOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.configuration(Configuration configuration)"
|
||||
name: "configuration(Configuration configuration)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder configuration(Configuration configuration)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.credential(com.azure.core.credential.KeyCredential)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.credential(KeyCredential keyCredential)"
|
||||
name: "credential(KeyCredential keyCredential)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder credential(KeyCredential keyCredential)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
name: "credential(TokenCredential tokenCredential)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder credential(TokenCredential tokenCredential)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.endpoint(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.endpoint(String endpoint)"
|
||||
name: "endpoint(String endpoint)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder endpoint(String endpoint)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.httpClient(HttpClient httpClient)"
|
||||
name: "httpClient(HttpClient httpClient)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder httpClient(HttpClient httpClient)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
name: "pipeline(HttpPipeline pipeline)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder pipeline(HttpPipeline pipeline)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
name: "retryOptions(RetryOptions retryOptions)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder retryOptions(RetryOptions retryOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
name: "retryPolicy(RetryPolicy retryPolicy)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.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 ImageAnalysisClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
||||
desc: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
returns:
|
||||
description: "the ImageAnalysisClientBuilder."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.serviceVersion(com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder.serviceVersion(ImageAnalysisServiceVersion serviceVersion)"
|
||||
name: "serviceVersion(ImageAnalysisServiceVersion serviceVersion)"
|
||||
nameWithType: "ImageAnalysisClientBuilder.serviceVersion(ImageAnalysisServiceVersion serviceVersion)"
|
||||
summary: "Sets Service version."
|
||||
parameters:
|
||||
- description: "the serviceVersion value."
|
||||
name: "serviceVersion"
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion&text=ImageAnalysisServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public ImageAnalysisClientBuilder serviceVersion(ImageAnalysisServiceVersion serviceVersion)"
|
||||
desc: "Sets Service version."
|
||||
returns:
|
||||
description: "the ImageAnalysisClientBuilder."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A builder for creating a new instance of the ImageAnalysisClient 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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" 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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" 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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" 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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" 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.imageanalysis.ImageAnalysisClientBuilder?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder&text=ImageAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,86 @@
|
|||
### YamlMime:JavaEnum
|
||||
uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion"
|
||||
name: "ImageAnalysisServiceVersion"
|
||||
nameWithType: "ImageAnalysisServiceVersion"
|
||||
summary: "Service version of Image<wbr>Analysis<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#describeConstable--\">describeConstable</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 **ImageAnalysisServiceVersion**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion&text=ImageAnalysisServiceVersion\" 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.imageanalysis.ImageAnalysisServiceVersion.V2023_10_01"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion.V2023_10_01"
|
||||
name: "V2023_10_01"
|
||||
nameWithType: "ImageAnalysisServiceVersion.V2023_10_01"
|
||||
summary: "Enum value 2023-10-01."
|
||||
desc: "Enum value 2023-10-01."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion.getLatest()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion.getLatest()"
|
||||
name: "getLatest()"
|
||||
nameWithType: "ImageAnalysisServiceVersion.getLatest()"
|
||||
summary: "Gets the latest service version supported by this client library."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static ImageAnalysisServiceVersion getLatest()"
|
||||
desc: "Gets the latest service version supported by this client library."
|
||||
returns:
|
||||
description: "The latest <xref uid=\"com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ImageAnalysisServiceVersion\"></xref>."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion&text=ImageAnalysisServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion.getVersion()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion.getVersion()"
|
||||
name: "getVersion()"
|
||||
nameWithType: "ImageAnalysisServiceVersion.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.imageanalysis.ImageAnalysisServiceVersion.valueOf(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion.valueOf(String name)"
|
||||
name: "valueOf(String name)"
|
||||
nameWithType: "ImageAnalysisServiceVersion.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 ImageAnalysisServiceVersion valueOf(String name)"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion&text=ImageAnalysisServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion.values()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion.values()"
|
||||
name: "values()"
|
||||
nameWithType: "ImageAnalysisServiceVersion.values()"
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static ImageAnalysisServiceVersion[] values()"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion?alt=com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion&text=ImageAnalysisServiceVersion\" data-throw-if-not-resolved=\"False\" />[]"
|
||||
desc: "Service version of ImageAnalysisClient."
|
||||
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.imageanalysis"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.CaptionResult"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CaptionResult"
|
||||
name: "CaptionResult"
|
||||
nameWithType: "CaptionResult"
|
||||
summary: "Represents a generated phrase that describes the content of the whole 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 **CaptionResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.CaptionResult?alt=com.azure.ai.vision.imageanalysis.models.CaptionResult&text=CaptionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.CaptionResult.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CaptionResult.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "CaptionResult.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Caption<wbr>Result from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static CaptionResult fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of CaptionResult from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of CaptionResult if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.CaptionResult?alt=com.azure.ai.vision.imageanalysis.models.CaptionResult&text=CaptionResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.CaptionResult.getConfidence()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CaptionResult.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "CaptionResult.getConfidence()"
|
||||
summary: "Get the confidence property: A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate. Higher values indicating higher confidence."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.CaptionResult.getText()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CaptionResult.getText()"
|
||||
name: "getText()"
|
||||
nameWithType: "CaptionResult.getText()"
|
||||
summary: "Get the text property: The text of the caption."
|
||||
syntax: "public String getText()"
|
||||
desc: "Get the text property: The text of the caption."
|
||||
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.vision.imageanalysis.models.CaptionResult.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CaptionResult.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "CaptionResult.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents a generated phrase that describes the content of the whole image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.CaptionResult?alt=com.azure.ai.vision.imageanalysis.models.CaptionResult&text=CaptionResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.CropRegion"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CropRegion"
|
||||
name: "CropRegion"
|
||||
nameWithType: "CropRegion"
|
||||
summary: "A region at the desired aspect ratio that can be used as image thumbnail."
|
||||
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 **CropRegion**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.CropRegion?alt=com.azure.ai.vision.imageanalysis.models.CropRegion&text=CropRegion\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.CropRegion.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CropRegion.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "CropRegion.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Crop<wbr>Region from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static CropRegion fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of CropRegion from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of CropRegion if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.CropRegion?alt=com.azure.ai.vision.imageanalysis.models.CropRegion&text=CropRegion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.CropRegion.getAspectRatio()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CropRegion.getAspectRatio()"
|
||||
name: "getAspectRatio()"
|
||||
nameWithType: "CropRegion.getAspectRatio()"
|
||||
summary: "Get the aspect<wbr>Ratio property: The aspect ratio of the crop region."
|
||||
syntax: "public double getAspectRatio()"
|
||||
desc: "Get the aspectRatio property: The aspect ratio of the crop region. Aspect ratio is calculated by dividing the width of the region in pixels by its height in pixels. The aspect ratio will be in the range 0.75 to 1.8 (inclusive) if provided by the developer during the analyze call. Otherwise, it will be in the range 0.5 to 2.0 (inclusive)."
|
||||
returns:
|
||||
description: "the aspectRatio value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.CropRegion.getBoundingBox()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CropRegion.getBoundingBox()"
|
||||
name: "getBoundingBox()"
|
||||
nameWithType: "CropRegion.getBoundingBox()"
|
||||
summary: "Get the bounding<wbr>Box property: The bounding box of the region."
|
||||
syntax: "public ImageBoundingBox getBoundingBox()"
|
||||
desc: "Get the boundingBox property: The bounding box of the region."
|
||||
returns:
|
||||
description: "the boundingBox value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageBoundingBox?alt=com.azure.ai.vision.imageanalysis.models.ImageBoundingBox&text=ImageBoundingBox\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.CropRegion.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.CropRegion.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "CropRegion.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A region at the desired aspect ratio that can be used as image thumbnail. The region preserves as much content as possible from the analyzed image, with priority given to detected faces."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.CropRegion?alt=com.azure.ai.vision.imageanalysis.models.CropRegion&text=CropRegion\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.DenseCaption"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaption"
|
||||
name: "DenseCaption"
|
||||
nameWithType: "DenseCaption"
|
||||
summary: "Represents a generated phrase that describes the content of the whole image or a region in 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 **DenseCaption**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DenseCaption?alt=com.azure.ai.vision.imageanalysis.models.DenseCaption&text=DenseCaption\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DenseCaption.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaption.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "DenseCaption.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Dense<wbr>Caption from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static DenseCaption fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of DenseCaption from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of DenseCaption if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.DenseCaption?alt=com.azure.ai.vision.imageanalysis.models.DenseCaption&text=DenseCaption\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DenseCaption.getBoundingBox()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaption.getBoundingBox()"
|
||||
name: "getBoundingBox()"
|
||||
nameWithType: "DenseCaption.getBoundingBox()"
|
||||
summary: "Get the bounding<wbr>Box property: The image region of which this caption applies."
|
||||
syntax: "public ImageBoundingBox getBoundingBox()"
|
||||
desc: "Get the boundingBox property: The image region of which this caption applies."
|
||||
returns:
|
||||
description: "the boundingBox value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageBoundingBox?alt=com.azure.ai.vision.imageanalysis.models.ImageBoundingBox&text=ImageBoundingBox\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DenseCaption.getConfidence()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaption.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "DenseCaption.getConfidence()"
|
||||
summary: "Get the confidence property: A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: A score, in the range of 0 to 1 (inclusive), representing the confidence that this description is accurate. Higher values indicating higher confidence."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DenseCaption.getText()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaption.getText()"
|
||||
name: "getText()"
|
||||
nameWithType: "DenseCaption.getText()"
|
||||
summary: "Get the text property: The text of the caption."
|
||||
syntax: "public String getText()"
|
||||
desc: "Get the text property: The text of the caption."
|
||||
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.vision.imageanalysis.models.DenseCaption.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaption.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "DenseCaption.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents a generated phrase that describes the content of the whole image or a region in the image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DenseCaption?alt=com.azure.ai.vision.imageanalysis.models.DenseCaption&text=DenseCaption\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult"
|
||||
name: "DenseCaptionsResult"
|
||||
nameWithType: "DenseCaptionsResult"
|
||||
summary: "Represents a list of up to 10 image captions for different regions 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 **DenseCaptionsResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult?alt=com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult&text=DenseCaptionsResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "DenseCaptionsResult.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Dense<wbr>Captions<wbr>Result from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static DenseCaptionsResult fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of DenseCaptionsResult from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of DenseCaptionsResult if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult?alt=com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult&text=DenseCaptionsResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult.getValues()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult.getValues()"
|
||||
name: "getValues()"
|
||||
nameWithType: "DenseCaptionsResult.getValues()"
|
||||
summary: "Get the values property: The list of image captions."
|
||||
syntax: "public List<DenseCaption> getValues()"
|
||||
desc: "Get the values property: The list of image captions."
|
||||
returns:
|
||||
description: "the values value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.DenseCaption?alt=com.azure.ai.vision.imageanalysis.models.DenseCaption&text=DenseCaption\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "DenseCaptionsResult.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents a list of up to 10 image captions for different regions of the image. The first caption always applies to the whole image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult?alt=com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult&text=DenseCaptionsResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.DetectedObject"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedObject"
|
||||
name: "DetectedObject"
|
||||
nameWithType: "DetectedObject"
|
||||
summary: "Represents a physical object detected in 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 **DetectedObject**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedObject?alt=com.azure.ai.vision.imageanalysis.models.DetectedObject&text=DetectedObject\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedObject.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedObject.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "DetectedObject.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Detected<wbr>Object from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static DetectedObject fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of DetectedObject from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of DetectedObject if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedObject?alt=com.azure.ai.vision.imageanalysis.models.DetectedObject&text=DetectedObject\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedObject.getBoundingBox()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedObject.getBoundingBox()"
|
||||
name: "getBoundingBox()"
|
||||
nameWithType: "DetectedObject.getBoundingBox()"
|
||||
summary: "Get the bounding<wbr>Box property: A rectangular boundary where the object was detected."
|
||||
syntax: "public ImageBoundingBox getBoundingBox()"
|
||||
desc: "Get the boundingBox property: A rectangular boundary where the object was detected."
|
||||
returns:
|
||||
description: "the boundingBox value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageBoundingBox?alt=com.azure.ai.vision.imageanalysis.models.ImageBoundingBox&text=ImageBoundingBox\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedObject.getTags()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedObject.getTags()"
|
||||
name: "getTags()"
|
||||
nameWithType: "DetectedObject.getTags()"
|
||||
summary: "Get the tags property: A single-item list containing the object information."
|
||||
syntax: "public List<DetectedTag> getTags()"
|
||||
desc: "Get the tags property: A single-item list containing the object information."
|
||||
returns:
|
||||
description: "the tags value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTag?alt=com.azure.ai.vision.imageanalysis.models.DetectedTag&text=DetectedTag\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedObject.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedObject.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "DetectedObject.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents a physical object detected in an image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedObject?alt=com.azure.ai.vision.imageanalysis.models.DetectedObject&text=DetectedObject\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.DetectedPerson"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedPerson"
|
||||
name: "DetectedPerson"
|
||||
nameWithType: "DetectedPerson"
|
||||
summary: "Represents a person detected in 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 **DetectedPerson**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedPerson?alt=com.azure.ai.vision.imageanalysis.models.DetectedPerson&text=DetectedPerson\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedPerson.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedPerson.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "DetectedPerson.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Detected<wbr>Person from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static DetectedPerson fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of DetectedPerson from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of DetectedPerson if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedPerson?alt=com.azure.ai.vision.imageanalysis.models.DetectedPerson&text=DetectedPerson\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedPerson.getBoundingBox()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedPerson.getBoundingBox()"
|
||||
name: "getBoundingBox()"
|
||||
nameWithType: "DetectedPerson.getBoundingBox()"
|
||||
summary: "Get the bounding<wbr>Box property: A rectangular boundary where the person was detected."
|
||||
syntax: "public ImageBoundingBox getBoundingBox()"
|
||||
desc: "Get the boundingBox property: A rectangular boundary where the person was detected."
|
||||
returns:
|
||||
description: "the boundingBox value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageBoundingBox?alt=com.azure.ai.vision.imageanalysis.models.ImageBoundingBox&text=ImageBoundingBox\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedPerson.getConfidence()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedPerson.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "DetectedPerson.getConfidence()"
|
||||
summary: "Get the confidence property: A score, in the range of 0 to 1 (inclusive), representing the confidence that this detection was accurate."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: A score, in the range of 0 to 1 (inclusive), representing the confidence that this detection was accurate. Higher values indicating higher confidence."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedPerson.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedPerson.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "DetectedPerson.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents a person detected in an image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedPerson?alt=com.azure.ai.vision.imageanalysis.models.DetectedPerson&text=DetectedPerson\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.DetectedTag"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTag"
|
||||
name: "DetectedTag"
|
||||
nameWithType: "DetectedTag"
|
||||
summary: "A content entity observation in 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 **DetectedTag**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTag?alt=com.azure.ai.vision.imageanalysis.models.DetectedTag&text=DetectedTag\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTag.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTag.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "DetectedTag.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Detected<wbr>Tag from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static DetectedTag fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of DetectedTag from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of DetectedTag if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTag?alt=com.azure.ai.vision.imageanalysis.models.DetectedTag&text=DetectedTag\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTag.getConfidence()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTag.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "DetectedTag.getConfidence()"
|
||||
summary: "Get the confidence property: A score, in the range of 0 to 1 (inclusive), representing the confidence that this entity was observed."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: A score, in the range of 0 to 1 (inclusive), representing the confidence that this entity was observed. Higher values indicating higher confidence."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTag.getName()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTag.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "DetectedTag.getName()"
|
||||
summary: "Get the name property: Name of the entity."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: Name of the entity."
|
||||
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.vision.imageanalysis.models.DetectedTag.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTag.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "DetectedTag.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A content entity observation in the image. A tag can be a physical object, living being, scenery, or action that appear in the image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTag?alt=com.azure.ai.vision.imageanalysis.models.DetectedTag&text=DetectedTag\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextBlock"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextBlock"
|
||||
name: "DetectedTextBlock"
|
||||
nameWithType: "DetectedTextBlock"
|
||||
summary: "Represents a single block of detected text in 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 **DetectedTextBlock**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextBlock?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextBlock&text=DetectedTextBlock\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextBlock.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextBlock.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "DetectedTextBlock.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Detected<wbr>Text<wbr>Block from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static DetectedTextBlock fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of DetectedTextBlock from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of DetectedTextBlock if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextBlock?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextBlock&text=DetectedTextBlock\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextBlock.getLines()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextBlock.getLines()"
|
||||
name: "getLines()"
|
||||
nameWithType: "DetectedTextBlock.getLines()"
|
||||
summary: "Get the lines property: A list of text lines in this block."
|
||||
syntax: "public List<DetectedTextLine> getLines()"
|
||||
desc: "Get the lines property: A list of text lines in this block."
|
||||
returns:
|
||||
description: "the lines value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextLine?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextLine&text=DetectedTextLine\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextBlock.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextBlock.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "DetectedTextBlock.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents a single block of detected text in the image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextBlock?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextBlock&text=DetectedTextBlock\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine"
|
||||
name: "DetectedTextLine"
|
||||
nameWithType: "DetectedTextLine"
|
||||
summary: "Represents a single line of text in 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 **DetectedTextLine**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextLine?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextLine&text=DetectedTextLine\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "DetectedTextLine.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Detected<wbr>Text<wbr>Line from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static DetectedTextLine fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of DetectedTextLine from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of DetectedTextLine if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextLine?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextLine&text=DetectedTextLine\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine.getBoundingPolygon()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine.getBoundingPolygon()"
|
||||
name: "getBoundingPolygon()"
|
||||
nameWithType: "DetectedTextLine.getBoundingPolygon()"
|
||||
summary: "Get the bounding<wbr>Polygon property: A bounding polygon around the text line."
|
||||
syntax: "public List<ImagePoint> getBoundingPolygon()"
|
||||
desc: "Get the boundingPolygon property: A bounding polygon around the text line. At the moment only quadrilaterals are supported (represented by 4 image points)."
|
||||
returns:
|
||||
description: "the boundingPolygon value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImagePoint?alt=com.azure.ai.vision.imageanalysis.models.ImagePoint&text=ImagePoint\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine.getText()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine.getText()"
|
||||
name: "getText()"
|
||||
nameWithType: "DetectedTextLine.getText()"
|
||||
summary: "Get the text property: Text content of the detected text line."
|
||||
syntax: "public String getText()"
|
||||
desc: "Get the text property: Text content of the detected text line."
|
||||
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.vision.imageanalysis.models.DetectedTextLine.getWords()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine.getWords()"
|
||||
name: "getWords()"
|
||||
nameWithType: "DetectedTextLine.getWords()"
|
||||
summary: "Get the words property: A list of words in this line."
|
||||
syntax: "public List<DetectedTextWord> getWords()"
|
||||
desc: "Get the words property: A list of words in this line."
|
||||
returns:
|
||||
description: "the words value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextWord?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextWord&text=DetectedTextWord\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextLine.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "DetectedTextLine.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents a single line of text in the image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextLine?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextLine&text=DetectedTextLine\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord"
|
||||
name: "DetectedTextWord"
|
||||
nameWithType: "DetectedTextWord"
|
||||
summary: "A word object consisting of a contiguous sequence of characters."
|
||||
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 **DetectedTextWord**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextWord?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextWord&text=DetectedTextWord\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "DetectedTextWord.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Detected<wbr>Text<wbr>Word from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static DetectedTextWord fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of DetectedTextWord from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of DetectedTextWord if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextWord?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextWord&text=DetectedTextWord\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord.getBoundingPolygon()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord.getBoundingPolygon()"
|
||||
name: "getBoundingPolygon()"
|
||||
nameWithType: "DetectedTextWord.getBoundingPolygon()"
|
||||
summary: "Get the bounding<wbr>Polygon property: A bounding polygon around the word."
|
||||
syntax: "public List<ImagePoint> getBoundingPolygon()"
|
||||
desc: "Get the boundingPolygon property: A bounding polygon around the word. At the moment only quadrilaterals are supported (represented by 4 image points)."
|
||||
returns:
|
||||
description: "the boundingPolygon value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImagePoint?alt=com.azure.ai.vision.imageanalysis.models.ImagePoint&text=ImagePoint\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord.getConfidence()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "DetectedTextWord.getConfidence()"
|
||||
summary: "Get the confidence property: The level of confidence that the word was detected."
|
||||
syntax: "public double getConfidence()"
|
||||
desc: "Get the confidence property: The level of confidence that the word was detected. Confidence scores span the range of 0.0 to 1.0 (inclusive), with higher values indicating a higher confidence of detection."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord.getText()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord.getText()"
|
||||
name: "getText()"
|
||||
nameWithType: "DetectedTextWord.getText()"
|
||||
summary: "Get the text property: Text content of the word."
|
||||
syntax: "public String getText()"
|
||||
desc: "Get the text property: Text content of the word."
|
||||
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.vision.imageanalysis.models.DetectedTextWord.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.DetectedTextWord.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "DetectedTextWord.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextWord?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextWord&text=DetectedTextWord\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,133 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions"
|
||||
name: "ImageAnalysisOptions"
|
||||
nameWithType: "ImageAnalysisOptions"
|
||||
summary: "Options for a single Image Analysis 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 **ImageAnalysisOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.ImageAnalysisOptions()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.ImageAnalysisOptions()"
|
||||
name: "ImageAnalysisOptions()"
|
||||
nameWithType: "ImageAnalysisOptions.ImageAnalysisOptions()"
|
||||
summary: "Creates an instance of Image<wbr>Analysis<wbr>Options class with default analysis options, as specified by the service."
|
||||
syntax: "public ImageAnalysisOptions()"
|
||||
desc: "Creates an instance of ImageAnalysisOptions class with default analysis options, as specified by the service. The Language used will be \"en\" (for English). Gender Neutral Caption is \"false\". One Smart Crop region with an aspect ratio the service sees fit. Model version is \"latest\"."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.getLanguage()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.getLanguage()"
|
||||
name: "getLanguage()"
|
||||
nameWithType: "ImageAnalysisOptions.getLanguage()"
|
||||
summary: "Get the language code"
|
||||
syntax: "public String getLanguage()"
|
||||
desc: "Get the language code"
|
||||
returns:
|
||||
description: "The language code"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.getModelVersion()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.getModelVersion()"
|
||||
name: "getModelVersion()"
|
||||
nameWithType: "ImageAnalysisOptions.getModelVersion()"
|
||||
summary: "Get the model version"
|
||||
syntax: "public String getModelVersion()"
|
||||
desc: "Get the model version"
|
||||
returns:
|
||||
description: "The model version"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.getSmartCropsAspectRatios()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.getSmartCropsAspectRatios()"
|
||||
name: "getSmartCropsAspectRatios()"
|
||||
nameWithType: "ImageAnalysisOptions.getSmartCropsAspectRatios()"
|
||||
summary: "Get the smart crop aspect rations"
|
||||
syntax: "public List<Double> getSmartCropsAspectRatios()"
|
||||
desc: "Get the smart crop aspect rations"
|
||||
returns:
|
||||
description: "The smart crop aspect rations"
|
||||
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/Double.html\">Double</a>>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.isGenderNeutralCaption()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.isGenderNeutralCaption()"
|
||||
name: "isGenderNeutralCaption()"
|
||||
nameWithType: "ImageAnalysisOptions.isGenderNeutralCaption()"
|
||||
summary: "Get the gender neutral caption selection"
|
||||
syntax: "public Boolean isGenderNeutralCaption()"
|
||||
desc: "Get the gender neutral caption selection"
|
||||
returns:
|
||||
description: "The gender neutral caption selection"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.setGenderNeutralCaption(java.lang.Boolean)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.setGenderNeutralCaption(Boolean genderNeutralCaption)"
|
||||
name: "setGenderNeutralCaption(Boolean genderNeutralCaption)"
|
||||
nameWithType: "ImageAnalysisOptions.setGenderNeutralCaption(Boolean genderNeutralCaption)"
|
||||
summary: "Sets the gender-neutral captioning option for visual features <xref uid=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures.CAPTION\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CAPTION\"></xref> and <xref uid=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures.DENSE_CAPTIONS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DENSE_CAPTIONS\"></xref>."
|
||||
parameters:
|
||||
- description: "Set to \"true\" to get gender neutral captions."
|
||||
name: "genderNeutralCaption"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public ImageAnalysisOptions setGenderNeutralCaption(Boolean genderNeutralCaption)"
|
||||
desc: "Sets the gender-neutral captioning option for visual features <xref uid=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures.CAPTION\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CAPTION\"></xref> and <xref uid=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures.DENSE_CAPTIONS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DENSE_CAPTIONS\"></xref>. If this parameter is not specified, the default value is \"false\". By default captions may contain gender terms (for example: 'man', 'woman', or 'boy', 'girl'). If you set this to \"true\", those will be replaced with gender-neutral terms (for example: 'person' or 'child')."
|
||||
returns:
|
||||
description: "Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.setLanguage(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.setLanguage(String language)"
|
||||
name: "setLanguage(String language)"
|
||||
nameWithType: "ImageAnalysisOptions.setLanguage(String language)"
|
||||
summary: "Sets the desired language for output generation."
|
||||
parameters:
|
||||
- description: "The langauge code to set, as specified in <a href=\"https://aka.ms/cv-languages\">https://aka.ms/cv-languages</a>."
|
||||
name: "language"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ImageAnalysisOptions setLanguage(String language)"
|
||||
desc: "Sets the desired language for output generation. At the moment this only applies to the visual feature <xref uid=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures.TAGS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TAGS\"></xref>. If this parameter is not specified, the default value is \"en\" for English. See https://aka.ms/cv-languages for a list of supported languages and to which visual feature they apply."
|
||||
returns:
|
||||
description: "Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.setModelVersion(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.setModelVersion(String modelVersion)"
|
||||
name: "setModelVersion(String modelVersion)"
|
||||
nameWithType: "ImageAnalysisOptions.setModelVersion(String modelVersion)"
|
||||
summary: "Set the version of cloud AI-model used for analysis."
|
||||
parameters:
|
||||
- description: "The model version to set."
|
||||
name: "modelVersion"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ImageAnalysisOptions setModelVersion(String modelVersion)"
|
||||
desc: "Set the version of cloud AI-model used for analysis. The format is the following: 'latest' (default value) or 'YYYY-MM-DD' or 'YYYY-MM-DD-preview', where 'YYYY', 'MM', 'DD' are the year, month and day associated with the model. This is not commonly set, as the default always gives the latest AI model with recent improvements. If however you would like to make sure analysis results do not change over time, set this value to a specific model version. Note that the model version is available in the Image Analysis Result (see com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getModelVersion)."
|
||||
returns:
|
||||
description: "Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.setSmartCropsAspectRatios(java.util.List<java.lang.Double>)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions.setSmartCropsAspectRatios(List<Double> smartCropsAspectRatios)"
|
||||
name: "setSmartCropsAspectRatios(List<Double> smartCropsAspectRatios)"
|
||||
nameWithType: "ImageAnalysisOptions.setSmartCropsAspectRatios(List<Double> smartCropsAspectRatios)"
|
||||
summary: "Set a list of aspect ratios for the visual feature <xref uid=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures.SMART_CROPS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SMART_CROPS\"></xref>."
|
||||
parameters:
|
||||
- description: "The list of aspect ratios to set."
|
||||
name: "smartCropsAspectRatios"
|
||||
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/Double.html\">Double</a>>"
|
||||
syntax: "public ImageAnalysisOptions setSmartCropsAspectRatios(List<Double> smartCropsAspectRatios)"
|
||||
desc: "Set a list of aspect ratios for the visual feature <xref uid=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures.SMART_CROPS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SMART_CROPS\"></xref>. Aspect ratios are calculated by dividing the target crop width in pixels by the height in pixels. Supported values are between 0.75 and 1.8 (inclusive). If this parameter is not specified, the service will return one crop region with an aspect ratio it sees fit between 0.5 and 2.0 (inclusive)."
|
||||
returns:
|
||||
description: "Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions&text=ImageAnalysisOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Options for a single Image Analysis operation."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,152 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult"
|
||||
name: "ImageAnalysisResult"
|
||||
nameWithType: "ImageAnalysisResult"
|
||||
summary: "Represents the outcome of an Image Analysis 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 **ImageAnalysisResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "ImageAnalysisResult.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Image<wbr>Analysis<wbr>Result from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static ImageAnalysisResult fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of ImageAnalysisResult from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of ImageAnalysisResult if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getCaption()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getCaption()"
|
||||
name: "getCaption()"
|
||||
nameWithType: "ImageAnalysisResult.getCaption()"
|
||||
summary: "Get the caption property: The generated phrase that describes the content of the analyzed image."
|
||||
syntax: "public CaptionResult getCaption()"
|
||||
desc: "Get the caption property: The generated phrase that describes the content of the analyzed image."
|
||||
returns:
|
||||
description: "the caption value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.CaptionResult?alt=com.azure.ai.vision.imageanalysis.models.CaptionResult&text=CaptionResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getDenseCaptions()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getDenseCaptions()"
|
||||
name: "getDenseCaptions()"
|
||||
nameWithType: "ImageAnalysisResult.getDenseCaptions()"
|
||||
summary: "Get the dense<wbr>Captions property: The up to 10 generated phrases, the first describing the content of the whole image, and the others describing the content of different regions of the image."
|
||||
syntax: "public DenseCaptionsResult getDenseCaptions()"
|
||||
desc: "Get the denseCaptions property: The up to 10 generated phrases, the first describing the content of the whole image, and the others describing the content of different regions of the image."
|
||||
returns:
|
||||
description: "the denseCaptions value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult?alt=com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult&text=DenseCaptionsResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getMetadata()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getMetadata()"
|
||||
name: "getMetadata()"
|
||||
nameWithType: "ImageAnalysisResult.getMetadata()"
|
||||
summary: "Get the metadata property: Metadata associated with the analyzed image."
|
||||
syntax: "public ImageMetadata getMetadata()"
|
||||
desc: "Get the metadata property: Metadata associated with the analyzed image."
|
||||
returns:
|
||||
description: "the metadata value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageMetadata?alt=com.azure.ai.vision.imageanalysis.models.ImageMetadata&text=ImageMetadata\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getModelVersion()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getModelVersion()"
|
||||
name: "getModelVersion()"
|
||||
nameWithType: "ImageAnalysisResult.getModelVersion()"
|
||||
summary: "Get the model<wbr>Version property: The cloud AI model used for the analysis."
|
||||
syntax: "public String getModelVersion()"
|
||||
desc: "Get the modelVersion property: The cloud AI model used for the analysis."
|
||||
returns:
|
||||
description: "the modelVersion value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getObjects()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getObjects()"
|
||||
name: "getObjects()"
|
||||
nameWithType: "ImageAnalysisResult.getObjects()"
|
||||
summary: "Get the objects property: A list of detected physical objects in the analyzed image, and their location."
|
||||
syntax: "public ObjectsResult getObjects()"
|
||||
desc: "Get the objects property: A list of detected physical objects in the analyzed image, and their location."
|
||||
returns:
|
||||
description: "the objects value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ObjectsResult?alt=com.azure.ai.vision.imageanalysis.models.ObjectsResult&text=ObjectsResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getPeople()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getPeople()"
|
||||
name: "getPeople()"
|
||||
nameWithType: "ImageAnalysisResult.getPeople()"
|
||||
summary: "Get the people property: A list of detected people in the analyzed image, and their location."
|
||||
syntax: "public PeopleResult getPeople()"
|
||||
desc: "Get the people property: A list of detected people in the analyzed image, and their location."
|
||||
returns:
|
||||
description: "the people value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.PeopleResult?alt=com.azure.ai.vision.imageanalysis.models.PeopleResult&text=PeopleResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getRead()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getRead()"
|
||||
name: "getRead()"
|
||||
nameWithType: "ImageAnalysisResult.getRead()"
|
||||
summary: "Get the read property: The extracted printed and hand-written text in the analyze image."
|
||||
syntax: "public ReadResult getRead()"
|
||||
desc: "Get the read property: The extracted printed and hand-written text in the analyze image. Also knows as OCR."
|
||||
returns:
|
||||
description: "the read value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ReadResult?alt=com.azure.ai.vision.imageanalysis.models.ReadResult&text=ReadResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getSmartCrops()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getSmartCrops()"
|
||||
name: "getSmartCrops()"
|
||||
nameWithType: "ImageAnalysisResult.getSmartCrops()"
|
||||
summary: "Get the smart<wbr>Crops property: A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails."
|
||||
syntax: "public SmartCropsResult getSmartCrops()"
|
||||
desc: "Get the smartCrops property: A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails. These regions preserve as much content as possible from the analyzed image, with priority given to detected faces."
|
||||
returns:
|
||||
description: "the smartCrops value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.SmartCropsResult?alt=com.azure.ai.vision.imageanalysis.models.SmartCropsResult&text=SmartCropsResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getTags()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.getTags()"
|
||||
name: "getTags()"
|
||||
nameWithType: "ImageAnalysisResult.getTags()"
|
||||
summary: "Get the tags property: A list of content tags in the analyzed image."
|
||||
syntax: "public TagsResult getTags()"
|
||||
desc: "Get the tags property: A list of content tags in the analyzed image."
|
||||
returns:
|
||||
description: "the tags value."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.TagsResult?alt=com.azure.ai.vision.imageanalysis.models.TagsResult&text=TagsResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "ImageAnalysisResult.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents the outcome of an Image Analysis operation."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult?alt=com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult&text=ImageAnalysisResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,113 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox"
|
||||
name: "ImageBoundingBox"
|
||||
nameWithType: "ImageBoundingBox"
|
||||
summary: "A basic rectangle specifying a sub-region 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 **ImageBoundingBox**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageBoundingBox?alt=com.azure.ai.vision.imageanalysis.models.ImageBoundingBox&text=ImageBoundingBox\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "ImageBoundingBox.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Image<wbr>Bounding<wbr>Box from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static ImageBoundingBox fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of ImageBoundingBox from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of ImageBoundingBox if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageBoundingBox?alt=com.azure.ai.vision.imageanalysis.models.ImageBoundingBox&text=ImageBoundingBox\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.getHeight()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.getHeight()"
|
||||
name: "getHeight()"
|
||||
nameWithType: "ImageBoundingBox.getHeight()"
|
||||
summary: "Get the height property: Height of the area, in pixels."
|
||||
syntax: "public int getHeight()"
|
||||
desc: "Get the height property: Height of the area, 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.imageanalysis.models.ImageBoundingBox.getWidth()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.getWidth()"
|
||||
name: "getWidth()"
|
||||
nameWithType: "ImageBoundingBox.getWidth()"
|
||||
summary: "Get the width property: Width of the area, in pixels."
|
||||
syntax: "public int getWidth()"
|
||||
desc: "Get the width property: Width of the area, in pixels."
|
||||
returns:
|
||||
description: "the width value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.getX()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.getX()"
|
||||
name: "getX()"
|
||||
nameWithType: "ImageBoundingBox.getX()"
|
||||
summary: "Get the x property: X-coordinate of the top left point of the area, in pixels."
|
||||
syntax: "public int getX()"
|
||||
desc: "Get the x property: X-coordinate of the top left point of the area, in pixels."
|
||||
returns:
|
||||
description: "the x value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.getY()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.getY()"
|
||||
name: "getY()"
|
||||
nameWithType: "ImageBoundingBox.getY()"
|
||||
summary: "Get the y property: Y-coordinate of the top left point of the area, in pixels."
|
||||
syntax: "public int getY()"
|
||||
desc: "Get the y property: Y-coordinate of the top left point of the area, in pixels."
|
||||
returns:
|
||||
description: "the y value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "ImageBoundingBox.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.toString()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox.toString()"
|
||||
name: "toString()"
|
||||
nameWithType: "ImageBoundingBox.toString()"
|
||||
summary: "Returns a compact string containing the bounding box values in a style suitable for printing."
|
||||
overridden: "java.lang.Object.toString()"
|
||||
syntax: "public String toString()"
|
||||
desc: "Returns a compact string containing the bounding box values in a style suitable for printing."
|
||||
returns:
|
||||
description: "a string containing the bounding box values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "A basic rectangle specifying a sub-region of the image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageBoundingBox?alt=com.azure.ai.vision.imageanalysis.models.ImageBoundingBox&text=ImageBoundingBox\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.ImageMetadata"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageMetadata"
|
||||
name: "ImageMetadata"
|
||||
nameWithType: "ImageMetadata"
|
||||
summary: "Metadata associated with the analyzed 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 **ImageMetadata**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageMetadata?alt=com.azure.ai.vision.imageanalysis.models.ImageMetadata&text=ImageMetadata\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageMetadata.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageMetadata.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "ImageMetadata.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Image<wbr>Metadata from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static ImageMetadata fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of ImageMetadata from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of ImageMetadata if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageMetadata?alt=com.azure.ai.vision.imageanalysis.models.ImageMetadata&text=ImageMetadata\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageMetadata.getHeight()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageMetadata.getHeight()"
|
||||
name: "getHeight()"
|
||||
nameWithType: "ImageMetadata.getHeight()"
|
||||
summary: "Get the height property: The height of the image in pixels."
|
||||
syntax: "public int getHeight()"
|
||||
desc: "Get the height property: The height of the image 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.imageanalysis.models.ImageMetadata.getWidth()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageMetadata.getWidth()"
|
||||
name: "getWidth()"
|
||||
nameWithType: "ImageMetadata.getWidth()"
|
||||
summary: "Get the width property: The width of the image in pixels."
|
||||
syntax: "public int getWidth()"
|
||||
desc: "Get the width property: The width of the image in pixels."
|
||||
returns:
|
||||
description: "the width value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImageMetadata.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImageMetadata.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "ImageMetadata.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Metadata associated with the analyzed image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImageMetadata?alt=com.azure.ai.vision.imageanalysis.models.ImageMetadata&text=ImageMetadata\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,93 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.ImagePoint"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImagePoint"
|
||||
name: "ImagePoint"
|
||||
nameWithType: "ImagePoint"
|
||||
summary: "Represents the coordinates of a single pixel in 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 **ImagePoint**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImagePoint?alt=com.azure.ai.vision.imageanalysis.models.ImagePoint&text=ImagePoint\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImagePoint.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImagePoint.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "ImagePoint.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Image<wbr>Point from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static ImagePoint fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of ImagePoint from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of ImagePoint if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ImagePoint?alt=com.azure.ai.vision.imageanalysis.models.ImagePoint&text=ImagePoint\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImagePoint.getX()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImagePoint.getX()"
|
||||
name: "getX()"
|
||||
nameWithType: "ImagePoint.getX()"
|
||||
summary: "Get the x property: The horizontal x-coordinate of this point, in pixels."
|
||||
syntax: "public int getX()"
|
||||
desc: "Get the x property: The horizontal x-coordinate of this point, in pixels. Zero values corresponds to the left-most pixels in the image."
|
||||
returns:
|
||||
description: "the x value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImagePoint.getY()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImagePoint.getY()"
|
||||
name: "getY()"
|
||||
nameWithType: "ImagePoint.getY()"
|
||||
summary: "Get the y property: The vertical y-coordinate of this point, in pixels."
|
||||
syntax: "public int getY()"
|
||||
desc: "Get the y property: The vertical y-coordinate of this point, in pixels. Zero values corresponds to the top-most pixels in the image."
|
||||
returns:
|
||||
description: "the y value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImagePoint.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImagePoint.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "ImagePoint.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ImagePoint.toString()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ImagePoint.toString()"
|
||||
name: "toString()"
|
||||
nameWithType: "ImagePoint.toString()"
|
||||
summary: "Returns a compact string containing the image point values in a style suitable for printing."
|
||||
overridden: "java.lang.Object.toString()"
|
||||
syntax: "public String toString()"
|
||||
desc: "Returns a compact string containing the image point values in a style suitable for printing."
|
||||
returns:
|
||||
description: "A string containing the image point values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Represents the coordinates of a single pixel in the image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ImagePoint?alt=com.azure.ai.vision.imageanalysis.models.ImagePoint&text=ImagePoint\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.ObjectsResult"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ObjectsResult"
|
||||
name: "ObjectsResult"
|
||||
nameWithType: "ObjectsResult"
|
||||
summary: "Represents a list of physical object detected in an image and their location."
|
||||
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 **ObjectsResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ObjectsResult?alt=com.azure.ai.vision.imageanalysis.models.ObjectsResult&text=ObjectsResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ObjectsResult.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ObjectsResult.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "ObjectsResult.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Objects<wbr>Result from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static ObjectsResult fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of ObjectsResult from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of ObjectsResult if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ObjectsResult?alt=com.azure.ai.vision.imageanalysis.models.ObjectsResult&text=ObjectsResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ObjectsResult.getValues()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ObjectsResult.getValues()"
|
||||
name: "getValues()"
|
||||
nameWithType: "ObjectsResult.getValues()"
|
||||
summary: "Get the values property: A list of physical object detected in an image and their location."
|
||||
syntax: "public List<DetectedObject> getValues()"
|
||||
desc: "Get the values property: A list of physical object detected in an image and their location."
|
||||
returns:
|
||||
description: "the values value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedObject?alt=com.azure.ai.vision.imageanalysis.models.DetectedObject&text=DetectedObject\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ObjectsResult.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ObjectsResult.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "ObjectsResult.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents a list of physical object detected in an image and their location."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ObjectsResult?alt=com.azure.ai.vision.imageanalysis.models.ObjectsResult&text=ObjectsResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.PeopleResult"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.PeopleResult"
|
||||
name: "PeopleResult"
|
||||
nameWithType: "PeopleResult"
|
||||
summary: "Represents a list of people detected in an image and their location."
|
||||
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 **PeopleResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.PeopleResult?alt=com.azure.ai.vision.imageanalysis.models.PeopleResult&text=PeopleResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.PeopleResult.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.PeopleResult.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "PeopleResult.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of People<wbr>Result from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static PeopleResult fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of PeopleResult from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of PeopleResult if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.PeopleResult?alt=com.azure.ai.vision.imageanalysis.models.PeopleResult&text=PeopleResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.PeopleResult.getValues()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.PeopleResult.getValues()"
|
||||
name: "getValues()"
|
||||
nameWithType: "PeopleResult.getValues()"
|
||||
summary: "Get the values property: A list of people detected in an image and their location."
|
||||
syntax: "public List<DetectedPerson> getValues()"
|
||||
desc: "Get the values property: A list of people detected in an image and their location."
|
||||
returns:
|
||||
description: "the values value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedPerson?alt=com.azure.ai.vision.imageanalysis.models.DetectedPerson&text=DetectedPerson\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.PeopleResult.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.PeopleResult.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "PeopleResult.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents a list of people detected in an image and their location."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.PeopleResult?alt=com.azure.ai.vision.imageanalysis.models.PeopleResult&text=PeopleResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.ReadResult"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ReadResult"
|
||||
name: "ReadResult"
|
||||
nameWithType: "ReadResult"
|
||||
summary: "The results of a Read (OCR) 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 **ReadResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ReadResult?alt=com.azure.ai.vision.imageanalysis.models.ReadResult&text=ReadResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ReadResult.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ReadResult.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "ReadResult.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Read<wbr>Result from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static ReadResult fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of ReadResult from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of ReadResult if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.ReadResult?alt=com.azure.ai.vision.imageanalysis.models.ReadResult&text=ReadResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ReadResult.getBlocks()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ReadResult.getBlocks()"
|
||||
name: "getBlocks()"
|
||||
nameWithType: "ReadResult.getBlocks()"
|
||||
summary: "Get the blocks property: A list of text blocks in the image."
|
||||
syntax: "public List<DetectedTextBlock> getBlocks()"
|
||||
desc: "Get the blocks property: A list of text blocks in the image. At the moment only one block is returned, containing all the text detected in the image."
|
||||
returns:
|
||||
description: "the blocks value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTextBlock?alt=com.azure.ai.vision.imageanalysis.models.DetectedTextBlock&text=DetectedTextBlock\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.ReadResult.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.ReadResult.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "ReadResult.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "The results of a Read (OCR) operation."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.ReadResult?alt=com.azure.ai.vision.imageanalysis.models.ReadResult&text=ReadResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.SmartCropsResult"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.SmartCropsResult"
|
||||
name: "SmartCropsResult"
|
||||
nameWithType: "SmartCropsResult"
|
||||
summary: "Smart cropping 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 **SmartCropsResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.SmartCropsResult?alt=com.azure.ai.vision.imageanalysis.models.SmartCropsResult&text=SmartCropsResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.SmartCropsResult.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.SmartCropsResult.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "SmartCropsResult.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Smart<wbr>Crops<wbr>Result from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static SmartCropsResult fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of SmartCropsResult from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of SmartCropsResult if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.SmartCropsResult?alt=com.azure.ai.vision.imageanalysis.models.SmartCropsResult&text=SmartCropsResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.SmartCropsResult.getValues()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.SmartCropsResult.getValues()"
|
||||
name: "getValues()"
|
||||
nameWithType: "SmartCropsResult.getValues()"
|
||||
summary: "Get the values property: A list of crop regions."
|
||||
syntax: "public List<CropRegion> getValues()"
|
||||
desc: "Get the values property: A list of crop regions."
|
||||
returns:
|
||||
description: "the values value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.CropRegion?alt=com.azure.ai.vision.imageanalysis.models.CropRegion&text=CropRegion\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.SmartCropsResult.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.SmartCropsResult.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "SmartCropsResult.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Smart cropping result. A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails. These regions preserve as much content as possible from the analyzed image, with priority given to detected faces."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.SmartCropsResult?alt=com.azure.ai.vision.imageanalysis.models.SmartCropsResult&text=SmartCropsResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.TagsResult"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.TagsResult"
|
||||
name: "TagsResult"
|
||||
nameWithType: "TagsResult"
|
||||
summary: "A list of entities observed in 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 **TagsResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.TagsResult?alt=com.azure.ai.vision.imageanalysis.models.TagsResult&text=TagsResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.TagsResult.fromJson(com.azure.json.JsonReader)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.TagsResult.fromJson(JsonReader jsonReader)"
|
||||
name: "fromJson(JsonReader jsonReader)"
|
||||
nameWithType: "TagsResult.fromJson(JsonReader jsonReader)"
|
||||
summary: "Reads an instance of Tags<wbr>Result from the Json<wbr>Reader."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "The JsonReader being read."
|
||||
name: "jsonReader"
|
||||
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static TagsResult fromJson(JsonReader jsonReader)"
|
||||
exceptions:
|
||||
- description: "If the deserialized JSON object was missing any required properties."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
desc: "Reads an instance of TagsResult from the JsonReader."
|
||||
returns:
|
||||
description: "An instance of TagsResult if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.TagsResult?alt=com.azure.ai.vision.imageanalysis.models.TagsResult&text=TagsResult\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.TagsResult.getValues()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.TagsResult.getValues()"
|
||||
name: "getValues()"
|
||||
nameWithType: "TagsResult.getValues()"
|
||||
summary: "Get the values property: A list of tags."
|
||||
syntax: "public List<DetectedTag> getValues()"
|
||||
desc: "Get the values property: A list of tags."
|
||||
returns:
|
||||
description: "the values value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.DetectedTag?alt=com.azure.ai.vision.imageanalysis.models.DetectedTag&text=DetectedTag\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.TagsResult.toJson(com.azure.json.JsonWriter)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.TagsResult.toJson(JsonWriter jsonWriter)"
|
||||
name: "toJson(JsonWriter jsonWriter)"
|
||||
nameWithType: "TagsResult.toJson(JsonWriter jsonWriter)"
|
||||
parameters:
|
||||
- name: "jsonWriter"
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
||||
exceptions:
|
||||
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A list of entities observed in the image. Tags can be physical objects, living being, scenery, or actions that appear in the image."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.vision.imageanalysis.models.TagsResult?alt=com.azure.ai.vision.imageanalysis.models.TagsResult&text=TagsResult\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,158 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures"
|
||||
name: "VisualFeatures"
|
||||
nameWithType: "VisualFeatures"
|
||||
summary: "The visual features supported by the Image Analysis service."
|
||||
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.getValue()?alt=com.azure.core.util.ExpandableStringEnum.getValue&text=getValue\" 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 **VisualFeatures**</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.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.VisualFeatures()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.VisualFeatures()"
|
||||
name: "VisualFeatures()"
|
||||
nameWithType: "VisualFeatures.VisualFeatures()"
|
||||
summary: "Creates a new instance of Visual<wbr>Features value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures.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 VisualFeatures()"
|
||||
desc: "Creates a new instance of VisualFeatures value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.CAPTION"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.CAPTION"
|
||||
name: "CAPTION"
|
||||
nameWithType: "VisualFeatures.CAPTION"
|
||||
summary: "Generate a human-readable caption sentence that describes the content of the image."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final VisualFeatures CAPTION"
|
||||
desc: "Generate a human-readable caption sentence that describes the content of the image."
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.DENSE_CAPTIONS"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.DENSE_CAPTIONS"
|
||||
name: "DENSE_CAPTIONS"
|
||||
nameWithType: "VisualFeatures.DENSE_CAPTIONS"
|
||||
summary: "Generate human-readable caption sentences for up to 10 different regions in the image, including one for the whole image."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final VisualFeatures DENSE_CAPTIONS"
|
||||
desc: "Generate human-readable caption sentences for up to 10 different regions in the image, including one for the whole image."
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.OBJECTS"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.OBJECTS"
|
||||
name: "OBJECTS"
|
||||
nameWithType: "VisualFeatures.OBJECTS"
|
||||
summary: "Object detection."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final VisualFeatures OBJECTS"
|
||||
desc: "Object detection. This is similar to tags, but focused on detecting physical objects in the image and returning their location."
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.PEOPLE"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.PEOPLE"
|
||||
name: "PEOPLE"
|
||||
nameWithType: "VisualFeatures.PEOPLE"
|
||||
summary: "Detect people in the image and return their location."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final VisualFeatures PEOPLE"
|
||||
desc: "Detect people in the image and return their location."
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.READ"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.READ"
|
||||
name: "READ"
|
||||
nameWithType: "VisualFeatures.READ"
|
||||
summary: "Extract printed or handwritten text from the image."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final VisualFeatures READ"
|
||||
desc: "Extract printed or handwritten text from the image. Also known as Optical Character Recognition (OCR)."
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.SMART_CROPS"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.SMART_CROPS"
|
||||
name: "SMART_CROPS"
|
||||
nameWithType: "VisualFeatures.SMART_CROPS"
|
||||
summary: "Find representative sub-regions of the image for thumbnail generation, at desired aspect ratios, with priority given to detected faces."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final VisualFeatures SMART_CROPS"
|
||||
desc: "Find representative sub-regions of the image for thumbnail generation, at desired aspect ratios, with priority given to detected faces."
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.TAGS"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.TAGS"
|
||||
name: "TAGS"
|
||||
nameWithType: "VisualFeatures.TAGS"
|
||||
summary: "Extract content tags for thousands of recognizable objects, living beings, scenery, and actions that appear in the image."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final VisualFeatures TAGS"
|
||||
desc: "Extract content tags for thousands of recognizable objects, living beings, scenery, and actions that appear in the image."
|
||||
methods:
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "VisualFeatures.fromString(String name)"
|
||||
summary: "Creates or finds a Visual<wbr>Features 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 VisualFeatures fromString(String name)"
|
||||
desc: "Creates or finds a VisualFeatures from its string representation."
|
||||
returns:
|
||||
description: "the corresponding VisualFeatures."
|
||||
type: "<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.values()"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models.VisualFeatures.values()"
|
||||
name: "values()"
|
||||
nameWithType: "VisualFeatures.values()"
|
||||
summary: "Gets known Visual<wbr>Features values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<VisualFeatures> values()"
|
||||
desc: "Gets known VisualFeatures values."
|
||||
returns:
|
||||
description: "known VisualFeatures values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.vision.imageanalysis.models.VisualFeatures?alt=com.azure.ai.vision.imageanalysis.models.VisualFeatures&text=VisualFeatures\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "The visual features supported by the Image Analysis service."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
### YamlMime:JavaPackage
|
||||
uid: "com.azure.ai.vision.imageanalysis.models"
|
||||
fullName: "com.azure.ai.vision.imageanalysis.models"
|
||||
name: "com.azure.ai.vision.imageanalysis.models"
|
||||
summary: "Package containing the data models for Image<wbr>Analysis."
|
||||
classes:
|
||||
- "com.azure.ai.vision.imageanalysis.models.CaptionResult"
|
||||
- "com.azure.ai.vision.imageanalysis.models.CropRegion"
|
||||
- "com.azure.ai.vision.imageanalysis.models.DenseCaption"
|
||||
- "com.azure.ai.vision.imageanalysis.models.DenseCaptionsResult"
|
||||
- "com.azure.ai.vision.imageanalysis.models.DetectedObject"
|
||||
- "com.azure.ai.vision.imageanalysis.models.DetectedPerson"
|
||||
- "com.azure.ai.vision.imageanalysis.models.DetectedTag"
|
||||
- "com.azure.ai.vision.imageanalysis.models.DetectedTextBlock"
|
||||
- "com.azure.ai.vision.imageanalysis.models.DetectedTextLine"
|
||||
- "com.azure.ai.vision.imageanalysis.models.DetectedTextWord"
|
||||
- "com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions"
|
||||
- "com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult"
|
||||
- "com.azure.ai.vision.imageanalysis.models.ImageBoundingBox"
|
||||
- "com.azure.ai.vision.imageanalysis.models.ImageMetadata"
|
||||
- "com.azure.ai.vision.imageanalysis.models.ImagePoint"
|
||||
- "com.azure.ai.vision.imageanalysis.models.ObjectsResult"
|
||||
- "com.azure.ai.vision.imageanalysis.models.PeopleResult"
|
||||
- "com.azure.ai.vision.imageanalysis.models.ReadResult"
|
||||
- "com.azure.ai.vision.imageanalysis.models.SmartCropsResult"
|
||||
- "com.azure.ai.vision.imageanalysis.models.TagsResult"
|
||||
- "com.azure.ai.vision.imageanalysis.models.VisualFeatures"
|
||||
desc: "Package containing the data models for ImageAnalysis."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis.models"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
### YamlMime:JavaPackage
|
||||
uid: "com.azure.ai.vision.imageanalysis"
|
||||
fullName: "com.azure.ai.vision.imageanalysis"
|
||||
name: "com.azure.ai.vision.imageanalysis"
|
||||
summary: "Package containing the classes for Image<wbr>Analysis."
|
||||
classes:
|
||||
- "com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient"
|
||||
- "com.azure.ai.vision.imageanalysis.ImageAnalysisClient"
|
||||
- "com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder"
|
||||
enums:
|
||||
- "com.azure.ai.vision.imageanalysis.ImageAnalysisServiceVersion"
|
||||
desc: "Package containing the classes for ImageAnalysis."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.vision.imageanalysis"
|
||||
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0
|
||||
|
|
@ -25,4 +25,4 @@ type: "class"
|
|||
desc: "The type Availability strategy."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -1057,4 +1057,4 @@ type: "class"
|
|||
desc: "DO NOT USE. This is meant to be used only internally as a bridge access to classes in com.azure.cosmos"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ type: "interface"
|
|||
desc: "Simple host for distributing change feed events across observers, simplifying the process of reading the change feeds and distributing the processing events across multiple consumers effectively.\n\nThere are four main components of implementing the change feed processor:\n\n * The monitored container: the monitored container has the data from which the change feed is generated. Any inserts and updates to the monitored container are reflected in the change feed of the container.\n * The lease container: the lease container acts as a state storage and coordinates processing the change feed across multiple workers. The lease container can be stored in the same account as the monitored container or in a separate account.\n * The host: a host is an application instance that uses the change feed processor to listen for changes. Multiple instances with the same lease configuration can run in parallel, but each instance should have a different instance name.\n * The delegate: the delegate is the code that defines what you, the developer, want to do with each batch of changes that the change feed processor reads.\n\nBelow is an example of building ChangeFeedProcessor for LatestVersion mode.\n\n```java\nChangeFeedProcessor changeFeedProcessor = new ChangeFeedProcessorBuilder()\n .hostName(hostName)\n .feedContainer(feedContainer)\n .leaseContainer(leaseContainer)\n .handleChanges(docs -> {\n for (JsonNode item : docs) {\n // Implementation for handling and processing of each JsonNode item goes here\n }\n })\n .buildChangeFeedProcessor();\n```\n\nBelow is an example of building ChangeFeedProcessor for AllVersionsAndDeletes mode.\n\n```java\nChangeFeedProcessor changeFeedProcessor = new ChangeFeedProcessorBuilder()\n .hostName(hostName)\n .feedContainer(feedContainer)\n .leaseContainer(leaseContainer)\n .handleAllVersionsAndDeletesChanges(docs -> {\n for (ChangeFeedProcessorItem item : docs) {\n // Implementation for handling and processing of each ChangeFeedProcessorItem item goes here\n }\n })\n .buildChangeFeedProcessor();\n```"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -156,4 +156,4 @@ type: "class"
|
|||
desc: "Helper class to build a <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> instance. Below is an example of building ChangeFeedProcessor for LatestVersion mode.\n\n```java\nChangeFeedProcessor changeFeedProcessor = new ChangeFeedProcessorBuilder()\n .hostName(hostName)\n .feedContainer(feedContainer)\n .leaseContainer(leaseContainer)\n .handleChanges(docs -> {\n for (JsonNode item : docs) {\n // Implementation for handling and processing of each JsonNode item goes here\n }\n })\n .buildChangeFeedProcessor();\n```\n\nBelow is an example of building ChangeFeedProcessor with throughput control for handleChanges.\n\n```java\nThroughputControlGroupConfig throughputControlGroupConfig =\n new ThroughputControlGroupConfigBuilder()\n .groupName(\"cfp\")\n .targetThroughput(300)\n .priorityLevel(PriorityLevel.LOW)\n .build();\n ChangeFeedProcessor changeFeedProcessor = new ChangeFeedProcessorBuilder()\n .hostName(hostName)\n .feedContainer(feedContainer)\n .leaseContainer(leaseContainer)\n .handleChanges(docs -> {\n for (JsonNode item : docs) {\n // Implementation for handling and processing of each JsonNode item goes here\n }\n })\n .options(\n new ChangeFeedProcessorOptions()\n .setFeedPollThroughputControlConfig(throughputControlGroupConfig)\n )\n .buildChangeFeedProcessor();\n```\n\nBelow is an example of building ChangeFeedProcessor with throughput control for LatestVersion mode.\n\n```java\nThroughputControlGroupConfig throughputControlGroupConfig =\n new ThroughputControlGroupConfigBuilder()\n .groupName(\"cfp\")\n .targetThroughput(300)\n .priorityLevel(PriorityLevel.LOW)\n .build();\n ChangeFeedProcessor changeFeedProcessor = new ChangeFeedProcessorBuilder()\n .hostName(hostName)\n .feedContainer(feedContainer)\n .leaseContainer(leaseContainer)\n .handleLatestVersionChanges(changeFeedProcessorItems -> {\n for (ChangeFeedProcessorItem item : changeFeedProcessorItems) {\n // Implementation for handling and processing of each change feed item goes here\n }\n })\n .options(\n new ChangeFeedProcessorOptions()\n .setFeedPollThroughputControlConfig(throughputControlGroupConfig)\n )\n .buildChangeFeedProcessor();\n```\n\nBelow is an example of building ChangeFeedProcessor for AllVersionsAndDeletes mode.\n\n```java\nChangeFeedProcessor changeFeedProcessor = new ChangeFeedProcessorBuilder()\n .hostName(hostName)\n .feedContainer(feedContainer)\n .leaseContainer(leaseContainer)\n .handleAllVersionsAndDeletesChanges(docs -> {\n for (ChangeFeedProcessorItem item : docs) {\n // Implementation for handling and processing of each ChangeFeedProcessorItem item goes here\n }\n })\n .buildChangeFeedProcessor();\n```\n\nBelow is an example of building ChangeFeedProcessor for AllVersionsAndDeletes mode when also wishing to process a <xref uid=\"com.azure.cosmos.ChangeFeedProcessorContext\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessorContext\"></xref>.\n\n```java\nChangeFeedProcessor changeFeedProcessor = new ChangeFeedProcessorBuilder()\n .hostName(hostName)\n .feedContainer(feedContainer)\n .leaseContainer(leaseContainer)\n .handleAllVersionsAndDeletesChanges((docs, context) -> {\n for (ChangeFeedProcessorItem item : docs) {\n // Implementation for handling and processing of each ChangeFeedProcessorItem item goes here\n }\n String leaseToken = context.getLeaseToken();\n // Handling of the lease token corresponding to a batch of change feed processor item goes here\n })\n .buildChangeFeedProcessor();\n```"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -6,18 +6,6 @@ nameWithType: "ChangeFeedProcessorContext"
|
|||
summary: "Encapsulates properties which are mapped to a batch of change feed documents processed when <xref uid=\"com.azure.cosmos.ChangeFeedProcessorBuilder.handleAllVersionsAndDeletesChanges*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessorBuilder#handleAllVersionsAndDeletesChanges(BiConsumer)\"></xref> lambda is invoked."
|
||||
syntax: "public interface **ChangeFeedProcessorContext**"
|
||||
methods:
|
||||
- uid: "com.azure.cosmos.ChangeFeedProcessorContext.getDiagnostics()"
|
||||
fullName: "com.azure.cosmos.ChangeFeedProcessorContext.getDiagnostics()"
|
||||
name: "getDiagnostics()"
|
||||
nameWithType: "ChangeFeedProcessorContext.getDiagnostics()"
|
||||
summary: "Get the diagnostics context from the underlying feed response."
|
||||
modifiers:
|
||||
- "default"
|
||||
syntax: "public default CosmosDiagnosticsContext getDiagnostics()"
|
||||
desc: "Get the diagnostics context from the underlying feed response."
|
||||
returns:
|
||||
description: "The diagnostics object."
|
||||
type: "<xref href=\"com.azure.cosmos.CosmosDiagnosticsContext?alt=com.azure.cosmos.CosmosDiagnosticsContext&text=CosmosDiagnosticsContext\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.cosmos.ChangeFeedProcessorContext.getLeaseToken()"
|
||||
fullName: "com.azure.cosmos.ChangeFeedProcessorContext.getLeaseToken()"
|
||||
name: "getLeaseToken()"
|
||||
|
|
@ -34,4 +22,4 @@ type: "interface"
|
|||
desc: "Encapsulates properties which are mapped to a batch of change feed documents processed when <xref uid=\"com.azure.cosmos.ChangeFeedProcessorBuilder.handleAllVersionsAndDeletesChanges*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessorBuilder#handleAllVersionsAndDeletesChanges(BiConsumer)\"></xref> lambda is invoked.\n\nNOTE: This interface is not designed to be implemented by end users."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -68,4 +68,4 @@ methods:
|
|||
desc: "Represents the connection mode to be used by the client in the Azure Cosmos DB database service.\n\nDIRECT and GATEWAY connectivity modes are supported. DIRECT is the default."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -94,4 +94,4 @@ methods:
|
|||
desc: "Represents the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service.\n\nThe requested ConsistencyLevel must match or be weaker than that provisioned for the database account. Consistency levels by order of strength are STRONG, BOUNDED\\_STALENESS, SESSION and EVENTUAL. Refer to consistency level documentation for additional details: https://docs.microsoft.com/en-us/azure/cosmos-db/consistency-levels"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -254,4 +254,4 @@ implements:
|
|||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html\">Closeable</a>"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -60,4 +60,4 @@ type: "class"
|
|||
desc: "The type Cosmos async clientEncryptionKey. This contains methods to operate on a cosmos clientEncryptionKey asynchronously"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -64,4 +64,4 @@ type: "class"
|
|||
desc: "Read and delete conflicts"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -836,4 +836,4 @@ type: "class"
|
|||
desc: "Provides methods for reading, deleting, and replacing existing Containers. Provides methods for interacting with child resources (Items, Scripts, Conflicts)"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -609,4 +609,4 @@ type: "class"
|
|||
desc: "Perform read and delete databases, update database throughput, and perform operations on child resources"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -81,4 +81,4 @@ type: "class"
|
|||
desc: "Has methods to operate on a per-User Permission to access a specific resource"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -259,4 +259,4 @@ type: "class"
|
|||
desc: "The type Cosmos async scripts. This contains async methods to operate on cosmos scripts like UDFs, StoredProcedures and Triggers"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -132,4 +132,4 @@ type: "class"
|
|||
desc: "The type Cosmos async stored procedure."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ type: "class"
|
|||
desc: "The type Cosmos async trigger. This contains methods to operate on a cosmos trigger asynchronously"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -159,4 +159,4 @@ type: "class"
|
|||
desc: "The type Cosmos async user."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ type: "class"
|
|||
desc: "The type Cosmos async user defined function."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -178,4 +178,4 @@ type: "class"
|
|||
desc: "DO NOT USE. For internal use only by the SDK. These methods might break at any time. No support will be provided."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -240,4 +240,4 @@ implements:
|
|||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html\">Closeable</a>"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -487,4 +487,4 @@ implements:
|
|||
- "<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.cosmos.CosmosClientBuilder?alt=com.azure.cosmos.CosmosClientBuilder&text=CosmosClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -46,4 +46,4 @@ type: "class"
|
|||
desc: "The type Cosmos clientEncryptionKey. This contains methods to operate on a cosmos clientEncryptionKey synchronously"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -690,4 +690,4 @@ type: "class"
|
|||
desc: "Provides synchronous methods for reading, deleting, and replacing existing Containers Provides methods for interacting with child resources (Items, Scripts, Conflicts)"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -54,4 +54,4 @@ type: "class"
|
|||
desc: "Encapsulates the list of container identities and no. of proactive connection regions."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -76,4 +76,4 @@ type: "class"
|
|||
desc: "A builder to build <xref uid=\"com.azure.cosmos.CosmosContainerProactiveInitConfig\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosContainerProactiveInitConfig\"></xref>"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -505,4 +505,4 @@ type: "class"
|
|||
desc: "Perform read and delete databases, update database throughput, and perform operations on child resources in a synchronous way"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -87,4 +87,4 @@ type: "class"
|
|||
desc: "This class represents response diagnostic statistics associated with a request to Azure Cosmos DB"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -336,4 +336,4 @@ type: "class"
|
|||
desc: "This class provides metadata for an operation in the Cosmos DB SDK that can be used by diagnostic handlers"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -39,4 +39,4 @@ type: "interface"
|
|||
desc: "And interface that can be implemented to add custom diagnostic processors"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -56,4 +56,4 @@ type: "class"
|
|||
desc: "This class represents diagnostic information for different steps in the request pipeline when processing a data plane request (for example to issue a point operation against a certain replica). This information can be useful to identify where in the request pipeline an error happened or latency was spent - for example whether high latency was due to the fact that a new channel (TCP connection with SSL handshake) needed to be created or because the transport took a long time due to network issues etc."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -106,4 +106,4 @@ type: "class"
|
|||
desc: "This class represents diagnostic information for transport requests (calls to a replica in direct mode, calls to the Gateway for example to get metadata like physical addresses of replica for a partition."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -163,4 +163,4 @@ type: "class"
|
|||
desc: "This class describes the thresholds when more details diagnostics are emitted for an operation due to high latency, high RU consumption or high payload sizes."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -64,4 +64,4 @@ type: "class"
|
|||
desc: "Represents End to end operation latency policy config This enables requests to get cancelled by the client once the specified timeout is reached"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -76,4 +76,4 @@ type: "class"
|
|||
desc: "Builder for CosmosEndToEndOperationLatencyPolicyConfig"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -286,4 +286,4 @@ type: "class"
|
|||
desc: "This class defines a custom exception type for all operations on CosmosClient in the Azure Cosmos DB database service. Applications are expected to catch CosmosException and handle errors as appropriate when calling methods on CosmosClient.\n\nErrors coming from the service during normal execution are converted to CosmosException before returning to the application with the following exception:\n\nWhen a BE error is encountered during a QueryIterable<T> iteration, an IllegalStateException is thrown instead of CosmosException.\n\nWhen a transport level error happens that request is not able to reach the service, an IllegalStateException is thrown instead of CosmosException."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -56,4 +56,4 @@ type: "class"
|
|||
desc: "A class which encapsulates a set of excluded regions."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -84,4 +84,4 @@ type: "class"
|
|||
desc: "The <xref uid=\"com.azure.cosmos.CosmosItemSerializer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemSerializer\"></xref> allows customizing the serialization of Cosmos Items - either to transform payload (for example wrap/unwrap in custom envelopes) or use custom serialization settings or json serializer stacks."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -23,4 +23,4 @@ type: "interface"
|
|||
desc: "Represents a policy that can be used with <xref uid=\"com.azure.cosmos.CosmosClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosClientBuilder\"></xref> to customize the request sent to Azure Cosmos DB."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -50,4 +50,4 @@ type: "class"
|
|||
desc: "<xref uid=\"com.azure.cosmos.CosmosRegionSwitchHint\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosRegionSwitchHint\"></xref> encapsulates hints which guide SDK-internal retry policies on how early to switch retries to a different region."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -210,4 +210,4 @@ type: "class"
|
|||
desc: "Getters for the common request context for operations in CosmosDB."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -259,4 +259,4 @@ type: "class"
|
|||
desc: "The type Cosmos sync scripts."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -136,4 +136,4 @@ type: "class"
|
|||
desc: "The type Cosmos sync stored procedure."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ type: "class"
|
|||
desc: "The type Cosmos sync trigger."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ type: "class"
|
|||
desc: "The type Cosmos sync user."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -70,4 +70,4 @@ type: "class"
|
|||
desc: "The type Cosmos sync user defined function."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -222,4 +222,4 @@ type: "class"
|
|||
desc: "Represents the connection config with <xref uid=\"com.azure.cosmos.ConnectionMode.DIRECT\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionMode#DIRECT\"></xref> associated with Cosmos Client in the Azure Cosmos DB database service. For performance tips on how to optimize Direct connection configuration, refer to performance tips guide: [Performance tips guide][]\n\n\n[Performance tips guide]: https://docs.microsoft.com/en-us/azure/cosmos-db/performance-tips-java-sdk-v4-sql?tabs=api-async"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -126,4 +126,4 @@ type: "class"
|
|||
desc: "Represents the connection config with <xref uid=\"com.azure.cosmos.ConnectionMode.GATEWAY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionMode#GATEWAY\"></xref> associated with Cosmos Client in the Azure Cosmos DB database service."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -46,4 +46,4 @@ type: "class"
|
|||
desc: "This configuration is used for throughput global control mode. It contains configuration about the extra container which will track all the clients throughput usage for a certain control group."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -64,4 +64,4 @@ type: "class"
|
|||
desc: "Throughput global control config builder."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -82,4 +82,4 @@ type: "class"
|
|||
desc: "Class to define the options for non-idempotent write operations"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -34,4 +34,4 @@ type: "class"
|
|||
desc: "<xref uid=\"com.azure.cosmos.SessionRetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SessionRetryOptions\"></xref> encapsulates hints which influence internal retry policies which are applied when the effective consistency used for the request is *Session Consistency*."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -84,4 +84,4 @@ type: "class"
|
|||
desc: "A <xref uid=\"com.azure.cosmos.SessionRetryOptionsBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SessionRetryOptionsBuilder\"></xref> instance will be used to build a <xref uid=\"com.azure.cosmos.SessionRetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SessionRetryOptions\"></xref> instance."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -77,4 +77,4 @@ type: "class"
|
|||
desc: "The type Threshold based retry availability strategy."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -90,4 +90,4 @@ type: "class"
|
|||
desc: "Encapsulates retry options in the Azure Cosmos DB database service."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -86,4 +86,4 @@ type: "class"
|
|||
desc: "Throughput control group configuration."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -182,4 +182,4 @@ type: "class"
|
|||
desc: "The throughput control group config builder."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -90,4 +90,4 @@ type: "class"
|
|||
desc: "Change Feed response meta data"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -74,4 +74,4 @@ methods:
|
|||
desc: "Change feed operation type"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -108,4 +108,4 @@ type: "class"
|
|||
desc: "Represents the change feed policy configuration for the container in the Azure Cosmos DB service.\n\nThe example below creates a new container with a change feed policy for AllVersionsAndDeletes change feed with a retention window of 8 minutes - so intermediary snapshots of changes as well as deleted documents would be available for processing for 8 minutes before they vanish. Processing the change feed with AllVersionsAndDeletes mode will only be able within this retention window - if you attempt to process a change feed after more than the retention window (8 minutes in this sample) an error (Status Code 400) will be returned. It would still be possible to process changes using LatestVersion mode even when configuring a AllVersionsAndDeletes change feed policy with retention window on the container and when using LatestVersion mode it doesn't matter whether you are out of the retention window or not.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(\"ContainerName\", \"/somePartitionKeyProperty\");\n containerProperties.setChangeFeedPolicy(ChangeFeedPolicy.createAllVersionsAndDeletesPolicy(8));\n\n CosmosAsyncDatabase database = client.createDatabase(databaseProperties).block().getDatabase();\n CosmosAsyncContainer container = database.createContainer(containerProperties).block().getContainer();\n```\n\nThe example below creates a new container with a change feed policy for LatestVersion change feed. Processing the change feed with AllVersionsAndDeletes mode will not be possible for this container. It would still be possible to process changes using LatestVersion mode. The LatestVersion change feed policy is also the default that is used when not explicitly specifying a change feed policy.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(\"ContainerName\", \"/somePartitionKeyProperty\");\n containerProperties.setChangeFeedPolicy(ChangeFeedPolicy.createLatestVersionPolicy());\n\n CosmosAsyncDatabase database = client.createDatabase(databaseProperties).block().getDatabase();\n CosmosAsyncContainer container = database.createContainer(containerProperties).block().getContainer();\n```"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -80,4 +80,4 @@ type: "class"
|
|||
desc: "Change Feed processor item. Supports current and previous items through <xref uid=\"com.fasterxml.jackson.databind.JsonNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonNode\"></xref> structure. Caller is recommended to type cast <xref uid=\"com.fasterxml.jackson.databind.JsonNode\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonNode\"></xref> to cosmos item structure."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -395,4 +395,4 @@ type: "class"
|
|||
desc: "Specifies the options associated with <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref>."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -128,4 +128,4 @@ type: "class"
|
|||
desc: "Specifies the <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> state for a particular lease/worker."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -128,4 +128,4 @@ type: "class"
|
|||
desc: "Path that needs encryption and the associated settings within <xref uid=\"com.azure.cosmos.models.ClientEncryptionPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientEncryptionPolicy\"></xref>."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -79,4 +79,4 @@ type: "class"
|
|||
desc: "Client encryption policy."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -101,4 +101,4 @@ type: "class"
|
|||
desc: "Represents a composite path of the IndexingPolicy in the Azure Cosmos DB database service. A composite path is used in a composite index. For example if you want to run a query like \"SELECT \\* FROM c ORDER BY c.age, c.height\", then you need to add \"/age\" and \"/height\" as composite paths to your composite index."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -68,4 +68,4 @@ methods:
|
|||
desc: "Represents the sorting order for a path in a composite index, for a container in the Azure Cosmos DB database service."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -61,4 +61,4 @@ type: "class"
|
|||
desc: "Represents a computed property definition for a Cosmos DB container. Below is an example of how to use <xref uid=\"com.azure.cosmos.models.ComputedProperty\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputedProperty\"></xref> in the context of creating a container.\n\n```java\nList<ComputedProperty> computedProperties = new ArrayList<>(\n Arrays.asList(\n new ComputedProperty(\"lowerName\", \"SELECT VALUE LOWER(c.name) FROM c\")\n )\n );\n containerProperties.setComputedProperties(computedProperties);\n database.createContainer(containerProperties).subscribe();\n```\n\nBelow is an example of how to use <xref uid=\"com.azure.cosmos.models.ComputedProperty\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputedProperty\"></xref> in the context of replacing a container.\n\n```java\nCosmosContainerProperties containerProperties = getCollectionDefinition(containerName);\n List<ComputedProperty> computedProperties = new ArrayList<>(\n Arrays.asList(\n new ComputedProperty(\"upperName\", \"SELECT VALUE UPPER(c.name) FROM c\")\n )\n );\n containerProperties.setComputedProperties(computedProperties);\n container = database.getContainer(containerName);\n container.replace(containerProperties).subscribe();\n```"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -82,4 +82,4 @@ methods:
|
|||
desc: "The enum Conflict resolution mode."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -134,4 +134,4 @@ type: "class"
|
|||
desc: "Represents the conflict resolution policy configuration for specifying how to resolve conflicts in case writes from different regions result in conflicts on items in the container in the Azure Cosmos DB service. Refer to: https://docs.microsoft.com/en-us/azure/cosmos-db/conflict-resolution-policies\n\nA container with custom conflict resolution with no user-registered stored procedure.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(\"Multi-master container\", \"Multi-master container partition key\");\n containerProperties.setConflictResolutionPolicy(ConflictResolutionPolicy.createCustomPolicy());\n\n CosmosAsyncDatabase database = client.createDatabase(databaseProperties).block().getDatabase();\n CosmosAsyncContainer container = database.createContainer(containerProperties).block().getContainer();\n```\n\nA container with custom conflict resolution with a user-registered stored procedure.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(\"Multi-master container\", \"Multi-master container partition key\");\n\n ConflictResolutionPolicy policy = ConflictResolutionPolicy.createCustomPolicy(conflictResolutionSprocName);\n containerProperties.setConflictResolutionPolicy(policy);\n\n CosmosAsyncDatabase database = client.createDatabase(databaseProperties).block().getDatabase();\n CosmosAsyncContainer container = database.createContainer(containerProperties).block().getContainer();\n```\n\nA container with last writer wins conflict resolution, based on a path in the conflicting items. A container with custom conflict resolution with a user-registered stored procedure.\n\n```java\nCosmosContainerProperties containerProperties =\n new CosmosContainerProperties(\"Multi-master container\", \"Multi-master container partition key\");\n\n ConflictResolutionPolicy policy = ConflictResolutionPolicy.createLastWriterWinsPolicy(\"/path/for/conflict/resolution\");\n containerProperties.setConflictResolutionPolicy(policy);\n\n CosmosAsyncDatabase database = client.createDatabase(databaseProperties).block().getDatabase();\n CosmosAsyncContainer container = database.createContainer(containerProperties).block().getContainer();\n```"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -88,4 +88,4 @@ methods:
|
|||
desc: "Specifies the kind of resource that has a Cosmos container as parent resource."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -35,4 +35,4 @@ type: "interface"
|
|||
desc: "This interface is for client side implementation, which can be used for initializing CosmosAsyncClient without passing master key, resource token and permission feed.\n\nEach time the SDK create request for CosmosDB, authorization token is generated based on that request at client side which enables creation of one CosmosAsyncClient per application shared across various users with different resource permissions."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -260,4 +260,4 @@ type: "class"
|
|||
desc: "Represents a batch of operations against items with the same <xref uid=\"com.azure.cosmos.models.PartitionKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionKey\"></xref> in a container that will be performed in a Cosmos manner at the Azure Cosmos DB service.\n\nUse <xref uid=\"com.azure.cosmos.models.CosmosBatch.createCosmosBatch(com.azure.cosmos.models.PartitionKey)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBatch#createCosmosBatch(PartitionKey)\"></xref> to create an instance of <xref uid=\"com.azure.cosmos.models.CosmosBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBatch\"></xref>. **Example** This example atomically modifies a set of items as a batch.\n\n```java\npublic class ToDoActivity {\n public final String type;\n public final String id;\n public final String status;\n public ToDoActivity(String type, String id, String status) {\n this.type = type;\n this.id = id;\n this.status = status;\n }\n }\n\n String activityType = \"personal\";\n\n ToDoActivity test1 = new ToDoActivity(activityType, \"learning\", \"ToBeDone\");\n ToDoActivity test2 = new ToDoActivity(activityType, \"shopping\", \"Done\");\n ToDoActivity test3 = new ToDoActivity(activityType, \"swimming\", \"ToBeDone\");\n\n CosmosBatch batch = CosmosBatch.createCosmosBatch(new Cosmos.PartitionKey(activityType));\n batch.createItemOperation(test1);\n batch.replaceItemOperation(test2.id, test2);\n batch.upsertItemOperation(test3);\n batch.deleteItemOperation(\"reading\");\n\n CosmosBatchResponse response = container.executeTransactionalBatch(batch);\n\n if (!response.isSuccessStatusCode()) {\n // Handle and log exception\n return;\n }\n\n // Look up interested results - e.g., via typed access on operation results\n\n CosmosBatchOperationResult result = response.get(0);\n ToDoActivity readActivity = result.getItem(ToDoActivity.class);\n```\n\n**Example**\n\nThis example atomically reads a set of items as a batch.\n\n```java\nString activityType = \"personal\";\n\n CosmosBatch batch = CosmosBatch.createCosmosBatch(new Cosmos.PartitionKey(activityType));\n batch.readItemOperation(\"playing\");\n batch.readItemOperation(\"walking\");\n batch.readItemOperation(\"jogging\");\n batch.readItemOperation(\"running\");\n\n CosmosBatchResponse response = container.executeTransactionalBatch(batch);\n List resultItems = new ArrayList();\n\n for (int i = 0; i < response.size(); i++) {\n CosmosBatchOperationResult result = response.get(0);\n resultItems.add(result.getItem(ToDoActivity.class));\n }\n```\n\n**See:** [Limits on CosmosBatch requests][].\n\n\n[Limits on CosmosBatch requests]: https://docs.microsoft.com/azure/cosmos-db/concepts-limits"
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
|
|
@ -96,4 +96,4 @@ type: "class"
|
|||
desc: "Encapsulates options that can be specified for an operation within a <xref uid=\"com.azure.cosmos.models.CosmosBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBatch\"></xref>."
|
||||
metadata: {}
|
||||
package: "com.azure.cosmos.models"
|
||||
artifact: com.azure:azure-cosmos:4.64.0
|
||||
artifact: com.azure:azure-cosmos:4.63.4
|
||||
|
|
|
|||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче