/
ImageAnalysisClient.cs
598 lines (567 loc) · 38.1 KB
/
ImageAnalysisClient.cs
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// <auto-generated/>
#nullable disable
using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Pipeline;
namespace Azure.AI.Vision.ImageAnalysis
{
// Data plane generated client.
/// <summary> The ImageAnalysis service client. </summary>
public partial class ImageAnalysisClient
{
private const string AuthorizationHeader = "Ocp-Apim-Subscription-Key";
private readonly AzureKeyCredential _keyCredential;
private readonly HttpPipeline _pipeline;
private readonly Uri _endpoint;
private readonly string _apiVersion;
/// <summary> The ClientDiagnostics is used to provide tracing support for the client library. </summary>
internal ClientDiagnostics ClientDiagnostics { get; }
/// <summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary>
public virtual HttpPipeline Pipeline => _pipeline;
/// <summary> Initializes a new instance of ImageAnalysisClient for mocking. </summary>
protected ImageAnalysisClient()
{
}
/// <summary> Initializes a new instance of ImageAnalysisClient. </summary>
/// <param name="endpoint">
/// Azure AI Computer Vision endpoint (protocol and hostname, for example:
/// https://<resource-name>.cognitiveservices.azure.com).
/// </param>
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="credential"/> is null. </exception>
public ImageAnalysisClient(Uri endpoint, AzureKeyCredential credential) : this(endpoint, credential, new ImageAnalysisClientOptions())
{
}
/// <summary> Initializes a new instance of ImageAnalysisClient. </summary>
/// <param name="endpoint">
/// Azure AI Computer Vision endpoint (protocol and hostname, for example:
/// https://<resource-name>.cognitiveservices.azure.com).
/// </param>
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
/// <param name="options"> The options for configuring the client. </param>
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="credential"/> is null. </exception>
public ImageAnalysisClient(Uri endpoint, AzureKeyCredential credential, ImageAnalysisClientOptions options)
{
Argument.AssertNotNull(endpoint, nameof(endpoint));
Argument.AssertNotNull(credential, nameof(credential));
options ??= new ImageAnalysisClientOptions();
ClientDiagnostics = new ClientDiagnostics(options, true);
_keyCredential = credential;
_pipeline = HttpPipelineBuilder.Build(options, Array.Empty<HttpPipelinePolicy>(), new HttpPipelinePolicy[] { new AzureKeyCredentialPolicy(_keyCredential, AuthorizationHeader) }, new ResponseClassifier());
_endpoint = endpoint;
_apiVersion = options.Version;
}
/// <summary> Performs a single Image Analysis operation. </summary>
/// <param name="visualFeatures">
/// A list of visual features to analyze.
/// Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.
/// At least one visual feature must be specified.
/// </param>
/// <param name="imageContent"> The image to be analyzed. </param>
/// <param name="language">
/// The desired language for result generation (a two-letter language code).
/// If this option is not specified, the default value 'en' is used (English).
/// See https://aka.ms/cv-languages for a list of supported languages.
/// </param>
/// <param name="genderNeutralCaption">
/// Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.
/// 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').
/// </param>
/// <param name="smartCropsAspectRatios">
/// A list of aspect ratios to use for smart cropping.
/// 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).
/// </param>
/// <param name="modelVersion">
/// 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.
/// </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="ArgumentNullException"> <paramref name="visualFeatures"/> or <paramref name="imageContent"/> is null. </exception>
internal virtual async Task<Response<ImageAnalysisResult>> AnalyzeFromImageDataAsync(IEnumerable<VisualFeaturesImpl> visualFeatures, BinaryData imageContent, string language = null, bool? genderNeutralCaption = null, IEnumerable<float> smartCropsAspectRatios = null, string modelVersion = null, CancellationToken cancellationToken = default)
{
Argument.AssertNotNull(visualFeatures, nameof(visualFeatures));
Argument.AssertNotNull(imageContent, nameof(imageContent));
using RequestContent content = imageContent;
RequestContext context = FromCancellationToken(cancellationToken);
Response response = await AnalyzeFromImageDataAsync(visualFeatures, content, language, genderNeutralCaption, smartCropsAspectRatios, modelVersion, context).ConfigureAwait(false);
return Response.FromValue(ImageAnalysisResult.FromResponse(response), response);
}
/// <summary> Performs a single Image Analysis operation. </summary>
/// <param name="visualFeatures">
/// A list of visual features to analyze.
/// Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.
/// At least one visual feature must be specified.
/// </param>
/// <param name="imageContent"> The image to be analyzed. </param>
/// <param name="language">
/// The desired language for result generation (a two-letter language code).
/// If this option is not specified, the default value 'en' is used (English).
/// See https://aka.ms/cv-languages for a list of supported languages.
/// </param>
/// <param name="genderNeutralCaption">
/// Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.
/// 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').
/// </param>
/// <param name="smartCropsAspectRatios">
/// A list of aspect ratios to use for smart cropping.
/// 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).
/// </param>
/// <param name="modelVersion">
/// 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.
/// </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="ArgumentNullException"> <paramref name="visualFeatures"/> or <paramref name="imageContent"/> is null. </exception>
internal virtual Response<ImageAnalysisResult> AnalyzeFromImageData(IEnumerable<VisualFeaturesImpl> visualFeatures, BinaryData imageContent, string language = null, bool? genderNeutralCaption = null, IEnumerable<float> smartCropsAspectRatios = null, string modelVersion = null, CancellationToken cancellationToken = default)
{
Argument.AssertNotNull(visualFeatures, nameof(visualFeatures));
Argument.AssertNotNull(imageContent, nameof(imageContent));
using RequestContent content = imageContent;
RequestContext context = FromCancellationToken(cancellationToken);
Response response = AnalyzeFromImageData(visualFeatures, content, language, genderNeutralCaption, smartCropsAspectRatios, modelVersion, context);
return Response.FromValue(ImageAnalysisResult.FromResponse(response), response);
}
/// <summary>
/// [Protocol Method] Performs a single Image Analysis operation
/// <list type="bullet">
/// <item>
/// <description>
/// This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
/// </description>
/// </item>
/// <item>
/// <description>
/// Please try the simpler <see cref="AnalyzeFromImageDataAsync(IEnumerable{VisualFeaturesImpl},BinaryData,string,bool?,IEnumerable{float},string,CancellationToken)"/> convenience overload with strongly typed models first.
/// </description>
/// </item>
/// </list>
/// </summary>
/// <param name="visualFeatures">
/// A list of visual features to analyze.
/// Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.
/// At least one visual feature must be specified.
/// </param>
/// <param name="content"> The content to send as the body of the request. </param>
/// <param name="language">
/// The desired language for result generation (a two-letter language code).
/// If this option is not specified, the default value 'en' is used (English).
/// See https://aka.ms/cv-languages for a list of supported languages.
/// </param>
/// <param name="genderNeutralCaption">
/// Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.
/// 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').
/// </param>
/// <param name="smartCropsAspectRatios">
/// A list of aspect ratios to use for smart cropping.
/// 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).
/// </param>
/// <param name="modelVersion">
/// 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.
/// </param>
/// <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
/// <exception cref="ArgumentNullException"> <paramref name="visualFeatures"/> or <paramref name="content"/> is null. </exception>
/// <exception cref="RequestFailedException"> Service returned a non-success status code. </exception>
/// <returns> The response returned from the service. </returns>
internal virtual async Task<Response> AnalyzeFromImageDataAsync(IEnumerable<VisualFeaturesImpl> visualFeatures, RequestContent content, string language = null, bool? genderNeutralCaption = null, IEnumerable<float> smartCropsAspectRatios = null, string modelVersion = null, RequestContext context = null)
{
Argument.AssertNotNull(visualFeatures, nameof(visualFeatures));
Argument.AssertNotNull(content, nameof(content));
using var scope = ClientDiagnostics.CreateScope("ImageAnalysisClient.AnalyzeFromImageData");
scope.Start();
try
{
using HttpMessage message = CreateAnalyzeFromImageDataRequest(visualFeatures, content, language, genderNeutralCaption, smartCropsAspectRatios, modelVersion, context);
return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false);
}
catch (Exception e)
{
scope.Failed(e);
throw;
}
}
/// <summary>
/// [Protocol Method] Performs a single Image Analysis operation
/// <list type="bullet">
/// <item>
/// <description>
/// This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
/// </description>
/// </item>
/// <item>
/// <description>
/// Please try the simpler <see cref="AnalyzeFromImageData(IEnumerable{VisualFeaturesImpl},BinaryData,string,bool?,IEnumerable{float},string,CancellationToken)"/> convenience overload with strongly typed models first.
/// </description>
/// </item>
/// </list>
/// </summary>
/// <param name="visualFeatures">
/// A list of visual features to analyze.
/// Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.
/// At least one visual feature must be specified.
/// </param>
/// <param name="content"> The content to send as the body of the request. </param>
/// <param name="language">
/// The desired language for result generation (a two-letter language code).
/// If this option is not specified, the default value 'en' is used (English).
/// See https://aka.ms/cv-languages for a list of supported languages.
/// </param>
/// <param name="genderNeutralCaption">
/// Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.
/// 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').
/// </param>
/// <param name="smartCropsAspectRatios">
/// A list of aspect ratios to use for smart cropping.
/// 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).
/// </param>
/// <param name="modelVersion">
/// 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.
/// </param>
/// <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
/// <exception cref="ArgumentNullException"> <paramref name="visualFeatures"/> or <paramref name="content"/> is null. </exception>
/// <exception cref="RequestFailedException"> Service returned a non-success status code. </exception>
/// <returns> The response returned from the service. </returns>
internal virtual Response AnalyzeFromImageData(IEnumerable<VisualFeaturesImpl> visualFeatures, RequestContent content, string language = null, bool? genderNeutralCaption = null, IEnumerable<float> smartCropsAspectRatios = null, string modelVersion = null, RequestContext context = null)
{
Argument.AssertNotNull(visualFeatures, nameof(visualFeatures));
Argument.AssertNotNull(content, nameof(content));
using var scope = ClientDiagnostics.CreateScope("ImageAnalysisClient.AnalyzeFromImageData");
scope.Start();
try
{
using HttpMessage message = CreateAnalyzeFromImageDataRequest(visualFeatures, content, language, genderNeutralCaption, smartCropsAspectRatios, modelVersion, context);
return _pipeline.ProcessMessage(message, context);
}
catch (Exception e)
{
scope.Failed(e);
throw;
}
}
/// <summary> Performs a single Image Analysis operation. </summary>
/// <param name="visualFeatures">
/// A list of visual features to analyze.
/// Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.
/// At least one visual feature must be specified.
/// </param>
/// <param name="imageContent"> The image to be analyzed. </param>
/// <param name="language">
/// The desired language for result generation (a two-letter language code).
/// If this option is not specified, the default value 'en' is used (English).
/// See https://aka.ms/cv-languages for a list of supported languages.
/// </param>
/// <param name="genderNeutralCaption">
/// Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.
/// 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').
/// </param>
/// <param name="smartCropsAspectRatios">
/// A list of aspect ratios to use for smart cropping.
/// 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).
/// </param>
/// <param name="modelVersion">
/// 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.
/// </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="ArgumentNullException"> <paramref name="visualFeatures"/> or <paramref name="imageContent"/> is null. </exception>
internal virtual async Task<Response<ImageAnalysisResult>> AnalyzeFromUrlAsync(IEnumerable<VisualFeaturesImpl> visualFeatures, ImageUrl imageContent, string language = null, bool? genderNeutralCaption = null, IEnumerable<float> smartCropsAspectRatios = null, string modelVersion = null, CancellationToken cancellationToken = default)
{
Argument.AssertNotNull(visualFeatures, nameof(visualFeatures));
Argument.AssertNotNull(imageContent, nameof(imageContent));
using RequestContent content = imageContent.ToRequestContent();
RequestContext context = FromCancellationToken(cancellationToken);
Response response = await AnalyzeFromUrlAsync(visualFeatures, content, language, genderNeutralCaption, smartCropsAspectRatios, modelVersion, context).ConfigureAwait(false);
return Response.FromValue(ImageAnalysisResult.FromResponse(response), response);
}
/// <summary> Performs a single Image Analysis operation. </summary>
/// <param name="visualFeatures">
/// A list of visual features to analyze.
/// Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.
/// At least one visual feature must be specified.
/// </param>
/// <param name="imageContent"> The image to be analyzed. </param>
/// <param name="language">
/// The desired language for result generation (a two-letter language code).
/// If this option is not specified, the default value 'en' is used (English).
/// See https://aka.ms/cv-languages for a list of supported languages.
/// </param>
/// <param name="genderNeutralCaption">
/// Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.
/// 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').
/// </param>
/// <param name="smartCropsAspectRatios">
/// A list of aspect ratios to use for smart cropping.
/// 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).
/// </param>
/// <param name="modelVersion">
/// 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.
/// </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="ArgumentNullException"> <paramref name="visualFeatures"/> or <paramref name="imageContent"/> is null. </exception>
internal virtual Response<ImageAnalysisResult> AnalyzeFromUrl(IEnumerable<VisualFeaturesImpl> visualFeatures, ImageUrl imageContent, string language = null, bool? genderNeutralCaption = null, IEnumerable<float> smartCropsAspectRatios = null, string modelVersion = null, CancellationToken cancellationToken = default)
{
Argument.AssertNotNull(visualFeatures, nameof(visualFeatures));
Argument.AssertNotNull(imageContent, nameof(imageContent));
using RequestContent content = imageContent.ToRequestContent();
RequestContext context = FromCancellationToken(cancellationToken);
Response response = AnalyzeFromUrl(visualFeatures, content, language, genderNeutralCaption, smartCropsAspectRatios, modelVersion, context);
return Response.FromValue(ImageAnalysisResult.FromResponse(response), response);
}
/// <summary>
/// [Protocol Method] Performs a single Image Analysis operation
/// <list type="bullet">
/// <item>
/// <description>
/// This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
/// </description>
/// </item>
/// <item>
/// <description>
/// Please try the simpler <see cref="AnalyzeFromUrlAsync(IEnumerable{VisualFeaturesImpl},ImageUrl,string,bool?,IEnumerable{float},string,CancellationToken)"/> convenience overload with strongly typed models first.
/// </description>
/// </item>
/// </list>
/// </summary>
/// <param name="visualFeatures">
/// A list of visual features to analyze.
/// Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.
/// At least one visual feature must be specified.
/// </param>
/// <param name="content"> The content to send as the body of the request. </param>
/// <param name="language">
/// The desired language for result generation (a two-letter language code).
/// If this option is not specified, the default value 'en' is used (English).
/// See https://aka.ms/cv-languages for a list of supported languages.
/// </param>
/// <param name="genderNeutralCaption">
/// Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.
/// 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').
/// </param>
/// <param name="smartCropsAspectRatios">
/// A list of aspect ratios to use for smart cropping.
/// 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).
/// </param>
/// <param name="modelVersion">
/// 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.
/// </param>
/// <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
/// <exception cref="ArgumentNullException"> <paramref name="visualFeatures"/> or <paramref name="content"/> is null. </exception>
/// <exception cref="RequestFailedException"> Service returned a non-success status code. </exception>
/// <returns> The response returned from the service. </returns>
internal virtual async Task<Response> AnalyzeFromUrlAsync(IEnumerable<VisualFeaturesImpl> visualFeatures, RequestContent content, string language = null, bool? genderNeutralCaption = null, IEnumerable<float> smartCropsAspectRatios = null, string modelVersion = null, RequestContext context = null)
{
Argument.AssertNotNull(visualFeatures, nameof(visualFeatures));
Argument.AssertNotNull(content, nameof(content));
using var scope = ClientDiagnostics.CreateScope("ImageAnalysisClient.AnalyzeFromUrl");
scope.Start();
try
{
using HttpMessage message = CreateAnalyzeFromUrlRequest(visualFeatures, content, language, genderNeutralCaption, smartCropsAspectRatios, modelVersion, context);
return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false);
}
catch (Exception e)
{
scope.Failed(e);
throw;
}
}
/// <summary>
/// [Protocol Method] Performs a single Image Analysis operation
/// <list type="bullet">
/// <item>
/// <description>
/// This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
/// </description>
/// </item>
/// <item>
/// <description>
/// Please try the simpler <see cref="AnalyzeFromUrl(IEnumerable{VisualFeaturesImpl},ImageUrl,string,bool?,IEnumerable{float},string,CancellationToken)"/> convenience overload with strongly typed models first.
/// </description>
/// </item>
/// </list>
/// </summary>
/// <param name="visualFeatures">
/// A list of visual features to analyze.
/// Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People.
/// At least one visual feature must be specified.
/// </param>
/// <param name="content"> The content to send as the body of the request. </param>
/// <param name="language">
/// The desired language for result generation (a two-letter language code).
/// If this option is not specified, the default value 'en' is used (English).
/// See https://aka.ms/cv-languages for a list of supported languages.
/// </param>
/// <param name="genderNeutralCaption">
/// Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features.
/// 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').
/// </param>
/// <param name="smartCropsAspectRatios">
/// A list of aspect ratios to use for smart cropping.
/// 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).
/// </param>
/// <param name="modelVersion">
/// 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.
/// </param>
/// <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
/// <exception cref="ArgumentNullException"> <paramref name="visualFeatures"/> or <paramref name="content"/> is null. </exception>
/// <exception cref="RequestFailedException"> Service returned a non-success status code. </exception>
/// <returns> The response returned from the service. </returns>
internal virtual Response AnalyzeFromUrl(IEnumerable<VisualFeaturesImpl> visualFeatures, RequestContent content, string language = null, bool? genderNeutralCaption = null, IEnumerable<float> smartCropsAspectRatios = null, string modelVersion = null, RequestContext context = null)
{
Argument.AssertNotNull(visualFeatures, nameof(visualFeatures));
Argument.AssertNotNull(content, nameof(content));
using var scope = ClientDiagnostics.CreateScope("ImageAnalysisClient.AnalyzeFromUrl");
scope.Start();
try
{
using HttpMessage message = CreateAnalyzeFromUrlRequest(visualFeatures, content, language, genderNeutralCaption, smartCropsAspectRatios, modelVersion, context);
return _pipeline.ProcessMessage(message, context);
}
catch (Exception e)
{
scope.Failed(e);
throw;
}
}
internal HttpMessage CreateAnalyzeFromImageDataRequest(IEnumerable<VisualFeaturesImpl> visualFeatures, RequestContent content, string language, bool? genderNeutralCaption, IEnumerable<float> smartCropsAspectRatios, string modelVersion, RequestContext context)
{
var message = _pipeline.CreateMessage(context, ResponseClassifier200);
var request = message.Request;
request.Method = RequestMethod.Post;
var uri = new RawRequestUriBuilder();
uri.Reset(_endpoint);
uri.AppendRaw("/computervision", false);
uri.AppendPath("/imageanalysis:analyze", false);
if (visualFeatures != null && !(visualFeatures is ChangeTrackingList<VisualFeaturesImpl> changeTrackingList && changeTrackingList.IsUndefined))
{
uri.AppendQueryDelimited("features", visualFeatures, ",", true);
}
uri.AppendQuery("api-version", _apiVersion, true);
if (language != null)
{
uri.AppendQuery("language", language, true);
}
if (genderNeutralCaption != null)
{
uri.AppendQuery("gender-neutral-caption", genderNeutralCaption.Value, true);
}
if (smartCropsAspectRatios != null && !(smartCropsAspectRatios is ChangeTrackingList<float> changeTrackingList0 && changeTrackingList0.IsUndefined))
{
uri.AppendQueryDelimited("smartcrops-aspect-ratios", smartCropsAspectRatios, ",", true);
}
if (modelVersion != null)
{
uri.AppendQuery("model-version", modelVersion, true);
}
request.Uri = uri;
request.Headers.Add("Accept", "application/json");
request.Headers.Add("content-type", "application/octet-stream");
request.Content = content;
return message;
}
internal HttpMessage CreateAnalyzeFromUrlRequest(IEnumerable<VisualFeaturesImpl> visualFeatures, RequestContent content, string language, bool? genderNeutralCaption, IEnumerable<float> smartCropsAspectRatios, string modelVersion, RequestContext context)
{
var message = _pipeline.CreateMessage(context, ResponseClassifier200);
var request = message.Request;
request.Method = RequestMethod.Post;
var uri = new RawRequestUriBuilder();
uri.Reset(_endpoint);
uri.AppendRaw("/computervision", false);
uri.AppendPath("/imageanalysis:analyze", false);
if (visualFeatures != null && !(visualFeatures is ChangeTrackingList<VisualFeaturesImpl> changeTrackingList && changeTrackingList.IsUndefined))
{
uri.AppendQueryDelimited("features", visualFeatures, ",", true);
}
uri.AppendQuery("api-version", _apiVersion, true);
if (language != null)
{
uri.AppendQuery("language", language, true);
}
if (genderNeutralCaption != null)
{
uri.AppendQuery("gender-neutral-caption", genderNeutralCaption.Value, true);
}
if (smartCropsAspectRatios != null && !(smartCropsAspectRatios is ChangeTrackingList<float> changeTrackingList0 && changeTrackingList0.IsUndefined))
{
uri.AppendQueryDelimited("smartcrops-aspect-ratios", smartCropsAspectRatios, ",", true);
}
if (modelVersion != null)
{
uri.AppendQuery("model-version", modelVersion, true);
}
request.Uri = uri;
request.Headers.Add("Accept", "application/json");
request.Headers.Add("content-type", "application/json");
request.Content = content;
return message;
}
private static RequestContext DefaultRequestContext = new RequestContext();
internal static RequestContext FromCancellationToken(CancellationToken cancellationToken = default)
{
if (!cancellationToken.CanBeCanceled)
{
return DefaultRequestContext;
}
return new RequestContext() { CancellationToken = cancellationToken };
}
private static ResponseClassifier _responseClassifier200;
private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 });
}
}