Scenarios and before/after
+ * + *operationId on status — Scenario: Caller needs the operation ID (e.g. to call + * getResultFile or deleteResult) after starting analyze.
+ *{@code
+ * // Before: generated model had no operationId; caller could not get it from the status.
+ * SyncPoller poller = client.beginAnalyze(...);
+ * ContentAnalyzerAnalyzeOperationStatus status = poller.getFinalResult(); // no getOperationId()
+ *
+ * // After: status carries operationId, set automatically by polling strategy from Operation-Location header.
+ * String id = status.getOperationId();
+ * client.getResultFile(analyzerId, id, ...);
+ * }
+ *
+ * Content/array/object field extensions — Scenario: Reading document fields + * (ContentField and subtypes StringField, NumberField, DateField, ObjectField, ArrayField) without + * casting to each subtype or manually navigating getValueObject()/getValueArray().
+ *ContentField.getValue() — get typed value without casting to StringField/NumberField/etc.:
+ *{@code
+ * // Before: Cast to subtype and call type-specific getter, then print.
+ * ContentField customerNameField = content.getFields().get("CustomerName");
+ * String customerName = customerNameField instanceof StringField
+ * ? ((StringField) customerNameField).getValueString() : null;
+ * System.out.println("Customer: " + customerName);
+ *
+ * // After: getValue() returns the typed value; no cast needed for console output.
+ * ContentField customerNameField = content.getFields().get("CustomerName");
+ * System.out.println("Customer: " + (customerNameField != null ? customerNameField.getValue() : null));
+ * }
+ * ObjectField.getFieldOrDefault() — navigate nested object by name:
+ *{@code
+ * // Before: Use getValueObject() and map lookup; cast to NumberField for value.
+ * ContentField totalField = content.getFields().get("TotalAmount");
+ * ObjectField totalObj = (ObjectField) totalField;
+ * ContentField amountField = totalObj.getValueObject() != null ? totalObj.getValueObject().get("Amount") : null;
+ * Double amount = amountField instanceof NumberField ? ((NumberField) amountField).getValueNumber() : null;
+ *
+ * // After: getFieldOrDefault(name); then getValue() for the typed value.
+ * ContentField totalField = content.getFields().get("TotalAmount");
+ * ObjectField totalObj = (ObjectField) totalField;
+ * ContentField amountField = totalObj.getFieldOrDefault("Amount");
+ * Double amount = amountField != null ? (Double) amountField.getValue() : null;
+ * }
+ * ArrayField.size() and get(i) — iterate array elements without getValueArray():
+ *{@code
+ * // Before: Call getValueArray() and use List size/get; null-check the list.
+ * ContentField lineItemsField = content.getFields().get("LineItems");
+ * ArrayField lineItems = (ArrayField) lineItemsField;
+ * int count = lineItems.getValueArray() != null ? lineItems.getValueArray().size() : 0;
+ * for (int i = 0; i < count; i++) {
+ * ContentField item = lineItems.getValueArray().get(i);
+ * // use item...
+ * }
+ *
+ * // After: size() and get(i) convenience methods; get(i) throws IndexOutOfBoundsException if out of range.
+ * ContentField lineItemsField = content.getFields().get("LineItems");
+ * ArrayField lineItems = (ArrayField) lineItemsField;
+ * for (int i = 0; i < lineItems.size(); i++) {
+ * ContentField item = lineItems.get(i);
+ * // use item...
+ * }
+ * }
+ *
+ * beginAnalyze / beginAnalyzeBinary without stringEncoding — Scenario: Start analyze + * with the default string encoding (utf16) without exposing encoding in the API.
+ *{@code
+ * // Before: Generated API required stringEncoding parameter (if present), e.g. beginAnalyze(..., "utf16").
+ *
+ * // After: Convenience overloads default utf16; caller uses simple signatures.
+ * SyncPoller<..., AnalyzeResult> poller = client.beginAnalyze(analyzerId, inputs);
+ * SyncPoller<..., AnalyzeResult> binaryPoller = client.beginAnalyzeBinary(analyzerId, binaryInput);
+ * }
+ *
+ * Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * inputs (Optional): [
+ * (Optional){
+ * url: String (Optional)
+ * data: byte[] (Optional)
+ * name: String (Optional)
+ * mimeType: String (Optional)
+ * range: String (Optional)
+ * }
+ * ]
+ * modelDeployments (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param analyzeRequest1 The analyzeRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for analyze operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
| range | String | No | Range of the input to analyze (ex. `1-3,5,9-`). Document content + * uses 1-based page numbers, while audio visual content uses integer milliseconds. |
Request Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param contentType Request content type.
+ * @param binaryInput The binary content of the document to analyze.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for analyze operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * sourceAzureResourceId: String (Optional)
+ * sourceRegion: String (Optional)
+ * sourceAnalyzerId: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param copyAnalyzerRequest The copyAnalyzerRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer properties along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return default settings for this Content Understanding resource along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of an analyzer creation operation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the result of an analysis operation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ MonoResponse Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param operationId Operation identifier.
+ * @param path File path.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a file associated with the result of an analysis operation along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * targetAzureResourceId: String (Required)
+ * targetRegion: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * source: String (Required)
+ * targetAzureResourceId: String (Required)
+ * expiresAt: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param grantCopyAuthorizationRequest1 The grantCopyAuthorizationRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return authorization for copying this analyzer to another location along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of ContentAnalyzer items as paginated response with {@link PagedFlux}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer that extracts content and fields from multimodal documents along with {@link Response} on
+ * successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Optional): {
+ * (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param updateDefaultsRequest The updateDefaultsRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return default settings for this Content Understanding resource along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * inputs (Optional): [
+ * (Optional){
+ * url: String (Optional)
+ * data: byte[] (Optional)
+ * name: String (Optional)
+ * mimeType: String (Optional)
+ * range: String (Optional)
+ * }
+ * ]
+ * modelDeployments (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param analyzeRequest1 The analyzeRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for analyze operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
| range | String | No | Range of the input to analyze (ex. `1-3,5,9-`). Document content + * uses 1-based page numbers, while audio visual content uses integer milliseconds. |
Request Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param contentType Request content type.
+ * @param binaryInput The binary content of the document to analyze.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for analyze operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * sourceAzureResourceId: String (Optional)
+ * sourceRegion: String (Optional)
+ * sourceAnalyzerId: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param copyAnalyzerRequest The copyAnalyzerRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer properties along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return default settings for this Content Understanding resource along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of an analyzer creation operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the result of an analysis operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ ResponseResponse Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param operationId Operation identifier.
+ * @param path File path.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a file associated with the result of an analysis operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * targetAzureResourceId: String (Required)
+ * targetRegion: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * source: String (Required)
+ * targetAzureResourceId: String (Required)
+ * expiresAt: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param grantCopyAuthorizationRequest1 The grantCopyAuthorizationRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return authorization for copying this analyzer to another location along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of ContentAnalyzer items as paginated response with {@link PagedIterable}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer that extracts content and fields from multimodal documents along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Optional): {
+ * (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param updateDefaultsRequest The updateDefaultsRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return default settings for this Content Understanding resource along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * inputs (Optional): [
+ * (Optional){
+ * url: String (Optional)
+ * data: byte[] (Optional)
+ * name: String (Optional)
+ * mimeType: String (Optional)
+ * range: String (Optional)
+ * }
+ * ]
+ * modelDeployments (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param analyzeRequest1 The analyzeRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return provides status details for analyze operations along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * inputs (Optional): [
+ * (Optional){
+ * url: String (Optional)
+ * data: byte[] (Optional)
+ * name: String (Optional)
+ * mimeType: String (Optional)
+ * range: String (Optional)
+ * }
+ * ]
+ * modelDeployments (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param analyzeRequest1 The analyzeRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return provides status details for analyze operations along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * inputs (Optional): [
+ * (Optional){
+ * url: String (Optional)
+ * data: byte[] (Optional)
+ * name: String (Optional)
+ * mimeType: String (Optional)
+ * range: String (Optional)
+ * }
+ * ]
+ * modelDeployments (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param analyzeRequest1 The analyzeRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for analyze operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * inputs (Optional): [
+ * (Optional){
+ * url: String (Optional)
+ * data: byte[] (Optional)
+ * name: String (Optional)
+ * mimeType: String (Optional)
+ * range: String (Optional)
+ * }
+ * ]
+ * modelDeployments (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param analyzeRequest1 The analyzeRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for analyze operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * inputs (Optional): [
+ * (Optional){
+ * url: String (Optional)
+ * data: byte[] (Optional)
+ * name: String (Optional)
+ * mimeType: String (Optional)
+ * range: String (Optional)
+ * }
+ * ]
+ * modelDeployments (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param analyzeRequest1 The analyzeRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for analyze operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * inputs (Optional): [
+ * (Optional){
+ * url: String (Optional)
+ * data: byte[] (Optional)
+ * name: String (Optional)
+ * mimeType: String (Optional)
+ * range: String (Optional)
+ * }
+ * ]
+ * modelDeployments (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param analyzeRequest1 The analyzeRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for analyze operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
| range | String | No | Range of the input to analyze (ex. `1-3,5,9-`). Document content + * uses 1-based page numbers, while audio visual content uses integer milliseconds. |
Request Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param contentType Request content type.
+ * @param binaryInput The binary content of the document to analyze.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return provides status details for analyze operations along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
| range | String | No | Range of the input to analyze (ex. `1-3,5,9-`). Document content + * uses 1-based page numbers, while audio visual content uses integer milliseconds. |
Request Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param contentType Request content type.
+ * @param binaryInput The binary content of the document to analyze.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return provides status details for analyze operations along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
| range | String | No | Range of the input to analyze (ex. `1-3,5,9-`). Document content + * uses 1-based page numbers, while audio visual content uses integer milliseconds. |
Request Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param contentType Request content type.
+ * @param binaryInput The binary content of the document to analyze.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for analyze operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
| range | String | No | Range of the input to analyze (ex. `1-3,5,9-`). Document content + * uses 1-based page numbers, while audio visual content uses integer milliseconds. |
Request Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param contentType Request content type.
+ * @param binaryInput The binary content of the document to analyze.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for analyze operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
| range | String | No | Range of the input to analyze (ex. `1-3,5,9-`). Document content + * uses 1-based page numbers, while audio visual content uses integer milliseconds. |
Request Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param contentType Request content type.
+ * @param binaryInput The binary content of the document to analyze.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for analyze operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| stringEncoding | String | No | The string encoding format for content spans in the + * response. + * Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") |
| processingLocation | String | No | The location where the data may be processed. + * Defaults to global. Allowed values: "geography", "dataZone", "global". |
| range | String | No | Range of the input to analyze (ex. `1-3,5,9-`). Document content + * uses 1-based page numbers, while audio visual content uses integer milliseconds. |
Request Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param contentType Request content type.
+ * @param binaryInput The binary content of the document to analyze.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for analyze operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * sourceAzureResourceId: String (Optional)
+ * sourceRegion: String (Optional)
+ * sourceAnalyzerId: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param copyAnalyzerRequest The copyAnalyzerRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer that extracts content and fields from multimodal documents along with {@link Response} on
+ * successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * sourceAzureResourceId: String (Optional)
+ * sourceRegion: String (Optional)
+ * sourceAnalyzerId: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param copyAnalyzerRequest The copyAnalyzerRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer that extracts content and fields from multimodal documents along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * sourceAzureResourceId: String (Optional)
+ * sourceRegion: String (Optional)
+ * sourceAnalyzerId: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param copyAnalyzerRequest The copyAnalyzerRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * sourceAzureResourceId: String (Optional)
+ * sourceRegion: String (Optional)
+ * sourceAnalyzerId: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param copyAnalyzerRequest The copyAnalyzerRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * sourceAzureResourceId: String (Optional)
+ * sourceRegion: String (Optional)
+ * sourceAnalyzerId: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param copyAnalyzerRequest The copyAnalyzerRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * sourceAzureResourceId: String (Optional)
+ * sourceRegion: String (Optional)
+ * sourceAnalyzerId: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param copyAnalyzerRequest The copyAnalyzerRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer that extracts content and fields from multimodal documents along with {@link Response} on
+ * successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer that extracts content and fields from multimodal documents along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| allowReplace | Boolean | No | Allow the operation to replace an existing + * resource. |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of analyzer that extracts content and fields from multimodal
+ * documents.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer properties along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer properties along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return default settings for this Content Understanding resource along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return default settings for this Content Understanding resource along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of an analyzer creation operation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of an analyzer creation operation along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the result of an analysis operation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * result (Optional): {
+ * analyzerId: String (Optional)
+ * apiVersion: String (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * warnings (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * stringEncoding: String (Optional)
+ * contents (Required): [
+ * (Required){
+ * kind: String(document/audioVisual) (Required)
+ * mimeType: String (Required)
+ * analyzerId: String (Optional)
+ * category: String (Optional)
+ * path: String (Optional)
+ * markdown: String (Optional)
+ * fields (Optional): {
+ * String (Required): {
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Required)
+ * spans (Optional): [
+ * (Optional){
+ * offset: int (Required)
+ * length: int (Required)
+ * }
+ * ]
+ * confidence: Double (Optional)
+ * source: String (Optional)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * usage (Optional): {
+ * documentPagesMinimal: Integer (Optional)
+ * documentPagesBasic: Integer (Optional)
+ * documentPagesStandard: Integer (Optional)
+ * audioHours: Double (Optional)
+ * videoHours: Double (Optional)
+ * contextualizationTokens: Integer (Optional)
+ * tokens (Optional): {
+ * String: int (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the result of an analysis operation along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param operationId Operation identifier.
+ * @param path File path.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a file associated with the result of an analysis operation along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param operationId Operation identifier.
+ * @param path File path.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a file associated with the result of an analysis operation along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * targetAzureResourceId: String (Required)
+ * targetRegion: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * source: String (Required)
+ * targetAzureResourceId: String (Required)
+ * expiresAt: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param grantCopyAuthorizationRequest1 The grantCopyAuthorizationRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return authorization for copying this analyzer to another location along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * targetAzureResourceId: String (Required)
+ * targetRegion: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * source: String (Required)
+ * targetAzureResourceId: String (Required)
+ * expiresAt: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param grantCopyAuthorizationRequest1 The grantCopyAuthorizationRequest1 parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return authorization for copying this analyzer to another location along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of ContentAnalyzer items along with {@link PagedResponse} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of ContentAnalyzer items as paginated response with {@link PagedFlux}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of ContentAnalyzer items along with {@link PagedResponse}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private PagedResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of ContentAnalyzer items as paginated response with {@link PagedIterable}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer that extracts content and fields from multimodal documents along with {@link Response} on
+ * successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param analyzerId The unique identifier of the analyzer.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return analyzer that extracts content and fields from multimodal documents along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Optional): {
+ * (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param updateDefaultsRequest The updateDefaultsRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return default settings for this Content Understanding resource along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Optional): {
+ * (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * modelDeployments (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param updateDefaultsRequest The updateDefaultsRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return default settings for this Content Understanding resource along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param nextLink The URL to get the next list of items.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of ContentAnalyzer items along with {@link PagedResponse} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * analyzerId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Required)
+ * }
+ * status: String(creating/ready/deleting/failed) (Required)
+ * createdAt: OffsetDateTime (Required)
+ * lastModifiedAt: OffsetDateTime (Required)
+ * warnings (Optional): [
+ * (Optional){
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * ]
+ * baseAnalyzerId: String (Optional)
+ * config (Optional): {
+ * returnDetails: Boolean (Optional)
+ * locales (Optional): [
+ * String (Optional)
+ * ]
+ * enableOcr: Boolean (Optional)
+ * enableLayout: Boolean (Optional)
+ * enableFigureDescription: Boolean (Optional)
+ * enableFigureAnalysis: Boolean (Optional)
+ * enableFormula: Boolean (Optional)
+ * tableFormat: String(html/markdown) (Optional)
+ * chartFormat: String(chartJs/markdown) (Optional)
+ * annotationFormat: String(none/markdown) (Optional)
+ * disableFaceBlurring: Boolean (Optional)
+ * estimateFieldSourceAndConfidence: Boolean (Optional)
+ * contentCategories (Optional): {
+ * String (Required): {
+ * description: String (Optional)
+ * analyzerId: String (Optional)
+ * analyzer (Optional): (recursive schema, see analyzer above)
+ * }
+ * }
+ * enableSegment: Boolean (Optional)
+ * segmentPerPage: Boolean (Optional)
+ * omitContent: Boolean (Optional)
+ * }
+ * fieldSchema (Optional): {
+ * name: String (Optional)
+ * description: String (Optional)
+ * fields (Optional, Required on create): {
+ * String (Required): {
+ * method: String(generate/extract/classify) (Optional)
+ * type: String(string/date/time/number/integer/boolean/array/object/json) (Optional)
+ * description: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * examples (Optional): [
+ * String (Optional)
+ * ]
+ * enum (Optional): [
+ * String (Optional)
+ * ]
+ * enumDescriptions (Optional): {
+ * String: String (Required)
+ * }
+ * $ref: String (Optional)
+ * estimateSourceAndConfidence: Boolean (Optional)
+ * }
+ * }
+ * definitions (Optional): {
+ * String (Required): (recursive schema, see String above)
+ * }
+ * }
+ * dynamicFieldSchema: Boolean (Optional)
+ * processingLocation: String(geography/dataZone/global) (Optional)
+ * knowledgeSources (Optional): [
+ * (Optional){
+ * kind: String(labeledData) (Required)
+ * }
+ * ]
+ * models (Optional): {
+ * String: String (Required)
+ * }
+ * supportedModels (Optional): {
+ * completion (Optional): [
+ * String (Optional)
+ * ]
+ * embedding (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @param nextLink The URL to get the next list of items.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of ContentAnalyzer items along with {@link PagedResponse}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private PagedResponse