Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| pages | String | No | List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | Locale hint for text recognition and document analysis. Value may contain only + * the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| split | String | No | Document splitting mode. Allowed values: "auto", "none", "perPage". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @param classifyRequest Classify request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| pages | String | No | List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | Locale hint for text recognition and document analysis. Value may contain only + * the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| split | String | No | Document splitting mode. Allowed values: "auto", "none", "perPage". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @param classifyRequest Classify request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Required)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * componentModels (Required): [
+ * (Required){
+ * modelId: String (Required)
+ * }
+ * ]
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param composeRequest Compose request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param authorizeCopyRequest Authorize copy request parameters.
+ * @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 to copy a document model to the specified target resource and modelId along with {@link
+ * Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @param copyToRequest Copy to request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (Optional)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 detailed document model information along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (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 DocumentModelDetails items as paginated response with {@link PagedFlux}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxResponse Body Schema + * + *
{@code
+ * {
+ * customDocumentModels (Required): {
+ * count: int (Required)
+ * limit: int (Required)
+ * }
+ * customNeuralDocumentModelBuilds (Required): {
+ * used: int (Required)
+ * quota: int (Required)
+ * quotaResetDateTime: OffsetDateTime (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 general information regarding the current resource along with {@link Response} on successful completion
+ * of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param operationId Operation ID.
+ * @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 operation info along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @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 OperationDetails items as paginated response with {@link PagedFlux}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxRequest Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @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 detailed document classifier information along with {@link Response} on successful completion of {@link
+ * Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: 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 paged collection of DocumentClassifierDetails items as paginated response with {@link PagedFlux}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Required)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * componentModels (Required): [
+ * (Required){
+ * modelId: String (Required)
+ * }
+ * ]
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param composeRequest Compose request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param authorizeCopyRequest Authorize copy request parameters.
+ * @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 to copy a document model to the specified target resource and modelId along with {@link
+ * Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @param copyToRequest Copy to request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (Optional)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 detailed document model information along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (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 DocumentModelDetails items as paginated response with {@link PagedIterable}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableResponse Body Schema + * + *
{@code
+ * {
+ * customDocumentModels (Required): {
+ * count: int (Required)
+ * limit: int (Required)
+ * }
+ * customNeuralDocumentModelBuilds (Required): {
+ * used: int (Required)
+ * quota: int (Required)
+ * quotaResetDateTime: OffsetDateTime (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 general information regarding the current resource along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param operationId Operation ID.
+ * @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 operation info along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @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 OperationDetails items as paginated response with {@link PagedIterable}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableRequest Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @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 detailed document classifier information along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: 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 paged collection of DocumentClassifierDetails items as paginated response with {@link PagedIterable}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| pages | String | No | List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | Locale hint for text recognition and document analysis. Value may contain only + * the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| pages | String | No | List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | Locale hint for text recognition and document analysis. Value may contain only + * the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| pages | String | No | List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | Locale hint for text recognition and document analysis. Value may contain only + * the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| pages | String | No | List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | Locale hint for text recognition and document analysis. Value may contain only + * the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| pages | String | No | List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | Locale hint for text recognition and document analysis. Value may contain only + * the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| pages | String | No | List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | Locale hint for text recognition and document analysis. Value may contain only + * the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| split | String | No | Document splitting mode. Allowed values: "auto", "none", "perPage". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @param classifyRequest Classify request parameters.
+ * @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 Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| split | String | No | Document splitting mode. Allowed values: "auto", "none", "perPage". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @param classifyRequest Classify request parameters.
+ * @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 Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| split | String | No | Document splitting mode. Allowed values: "auto", "none", "perPage". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @param classifyRequest Classify request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| split | String | No | Document splitting mode. Allowed values: "auto", "none", "perPage". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @param classifyRequest Classify request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| split | String | No | Document splitting mode. Allowed values: "auto", "none", "perPage". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @param classifyRequest Classify request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| split | String | No | Document splitting mode. Allowed values: "auto", "none", "perPage". |
Request Body Schema + * + *
{@code
+ * {
+ * urlSource: String (Optional)
+ * base64Source: byte[] (Optional)
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @param classifyRequest Classify request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Required)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Required)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Required)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Required)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Required)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Required)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * componentModels (Required): [
+ * (Required){
+ * modelId: String (Required)
+ * }
+ * ]
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param composeRequest Compose request parameters.
+ * @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 Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * componentModels (Required): [
+ * (Required){
+ * modelId: String (Required)
+ * }
+ * ]
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param composeRequest Compose request parameters.
+ * @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 Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * componentModels (Required): [
+ * (Required){
+ * modelId: String (Required)
+ * }
+ * ]
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param composeRequest Compose request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * componentModels (Required): [
+ * (Required){
+ * modelId: String (Required)
+ * }
+ * ]
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param composeRequest Compose request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * componentModels (Required): [
+ * (Required){
+ * modelId: String (Required)
+ * }
+ * ]
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param composeRequest Compose request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * componentModels (Required): [
+ * (Required){
+ * modelId: String (Required)
+ * }
+ * ]
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * @param composeRequest Compose request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param authorizeCopyRequest Authorize copy request parameters.
+ * @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 to copy a document model to the specified target resource and modelId along with {@link
+ * Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param authorizeCopyRequest Authorize copy request parameters.
+ * @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 to copy a document model to the specified target resource and modelId along with {@link
+ * Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @param copyToRequest Copy to request parameters.
+ * @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 Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoRequest Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @param copyToRequest Copy to request parameters.
+ * @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 Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseRequest Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @param copyToRequest Copy to request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @param copyToRequest Copy to request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @param copyToRequest Copy to request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * targetResourceId: String (Required)
+ * targetResourceRegion: String (Required)
+ * targetModelId: String (Required)
+ * targetModelLocation: String (Required)
+ * accessToken: String (Required)
+ * expirationDateTime: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @param copyToRequest Copy to request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (Optional)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 detailed document model information along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (Optional)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param modelId Unique document model name.
+ * @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 detailed document model information along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (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 DocumentModelDetails items along with {@link PagedResponse} on successful completion
+ * of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (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 DocumentModelDetails items as paginated response with {@link PagedFlux}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (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 DocumentModelDetails items along with {@link PagedResponse}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private PagedResponseResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (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 DocumentModelDetails items as paginated response with {@link PagedIterable}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableResponse Body Schema + * + *
{@code
+ * {
+ * customDocumentModels (Required): {
+ * count: int (Required)
+ * limit: int (Required)
+ * }
+ * customNeuralDocumentModelBuilds (Required): {
+ * used: int (Required)
+ * quota: int (Required)
+ * quotaResetDateTime: OffsetDateTime (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 general information regarding the current resource along with {@link Response} on successful completion
+ * of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * customDocumentModels (Required): {
+ * count: int (Required)
+ * limit: int (Required)
+ * }
+ * customNeuralDocumentModelBuilds (Required): {
+ * used: int (Required)
+ * quota: int (Required)
+ * quotaResetDateTime: OffsetDateTime (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 general information regarding the current resource along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param operationId Operation ID.
+ * @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 operation info along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param operationId Operation ID.
+ * @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 operation info along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @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 OperationDetails items along with {@link PagedResponse} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @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 OperationDetails items as paginated response with {@link PagedFlux}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @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 OperationDetails items along with {@link PagedResponse}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private PagedResponseResponse Body Schema + * + *
{@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @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 OperationDetails items as paginated response with {@link PagedIterable}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableRequest Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoRequest Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseRequest Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param buildRequest Build request parameters.
+ * @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 long-running operation.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @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 detailed document classifier information along with {@link Response} on successful completion of {@link
+ * Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param classifierId Unique document classifier name.
+ * @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 detailed document classifier information along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: 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 paged collection of DocumentClassifierDetails items along with {@link PagedResponse} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: 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 paged collection of DocumentClassifierDetails items as paginated response with {@link PagedFlux}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: 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 paged collection of DocumentClassifierDetails items along with {@link PagedResponse}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private PagedResponseResponse Body Schema + * + *
{@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: 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 paged collection of DocumentClassifierDetails items as paginated response with {@link PagedIterable}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableResponse Body Schema + * + *
{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (Optional)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param nextLink The URL to get the next list of items
+ * The nextLink 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 paged collection of DocumentModelDetails items along with {@link PagedResponse} on successful completion
+ * of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private Mono Response Body Schema
+ *
+ * The nextLink 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 paged collection of DocumentModelDetails items along with {@link PagedResponse}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private PagedResponse Response Body Schema
+ *
+ * The nextLink 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 paged collection of OperationDetails items along with {@link PagedResponse} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private Mono Response Body Schema
+ *
+ * The nextLink 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 paged collection of OperationDetails items along with {@link PagedResponse}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private PagedResponse Response Body Schema
+ *
+ * The nextLink 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 paged collection of DocumentClassifierDetails items along with {@link PagedResponse} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private Mono Response Body Schema
+ *
+ * The nextLink 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 paged collection of DocumentClassifierDetails items along with {@link PagedResponse}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private PagedResponse{@code
+ * {
+ * modelId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * buildMode: String(template/neural) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * docTypes (Optional): {
+ * String (Optional): {
+ * description: String (Optional)
+ * buildMode: String(template/neural) (Optional)
+ * fieldSchema (Required): {
+ * String (Required): {
+ * type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean) (Required)
+ * description: String (Optional)
+ * example: String (Optional)
+ * items (Optional): (recursive schema, see items above)
+ * properties (Optional): {
+ * String (Optional): (recursive schema, see String above)
+ * }
+ * }
+ * }
+ * fieldConfidence (Optional): {
+ * String: double (Optional)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param nextLink The URL to get the next list of items
+ * {@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param nextLink The URL to get the next list of items
+ * {@code
+ * {
+ * operationId: String (Required)
+ * status: String(notStarted/running/failed/succeeded/canceled) (Required)
+ * percentCompleted: Integer (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * lastUpdatedDateTime: OffsetDateTime (Required)
+ * resourceLocation: String (Required)
+ * apiVersion: String (Optional)
+ * tags (Optional): {
+ * String: String (Optional)
+ * }
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Optional)
+ * message: String (Optional)
+ * innererror (Optional): (recursive schema, see innererror above)
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param nextLink The URL to get the next list of items
+ * {@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param nextLink The URL to get the next list of items
+ * {@code
+ * {
+ * classifierId: String (Required)
+ * description: String (Optional)
+ * createdDateTime: OffsetDateTime (Required)
+ * expirationDateTime: OffsetDateTime (Optional)
+ * apiVersion: String (Required)
+ * docTypes (Required): {
+ * String (Required): {
+ * sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
+ * azureBlobSource (Optional): {
+ * containerUrl: String (Required)
+ * prefix: String (Optional)
+ * }
+ * azureBlobFileListSource (Optional): {
+ * containerUrl: String (Required)
+ * fileList: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ * @param nextLink The URL to get the next list of items
+ *