-
Notifications
You must be signed in to change notification settings - Fork 221
/
com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.yml
115 lines (115 loc) · 16.6 KB
/
com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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.\n //\n ImageAnalysisAsyncClient client = new ImageAnalysisClientBuilder()\n .endpoint(endpoint)\n .credential(new KeyCredential(key))\n .buildAsyncClient();\n```"
metadata: {}
package: "com.azure.ai.vision.imageanalysis"
artifact: com.azure:azure-ai-vision-imageanalysis:1.0.0-beta.2