Recognize symbols and tags from a raster PnID.

pnid-to-itwin-v2

---

Gets PnID Inference by specified id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference

inferenceId

OAuth access token with scope `synchronization:read`

Authorization

Setting to `application/vnd.bentley.itwin-platform.v2+json` is required.

Accept

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

application/json;InvalidAuthorizationScheme

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

Link

href

string

PnIDInference

modelVersion

Date time of last PnID Inference modification.

lastModifiedDateTime

date-time

createdDateTime

Contains the hyperlinks to related data of PnID Inference.

_links

PnIDInferenceLinks

PnID Inference

PnIDInferenceResult

inference

PnID Inference Result

iTwin

inputs

results

Error

One of a server-defined set of error codes.

code

A human-readable representation of the error.

message

target

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

ErrorResponse

error

Error Response

---
Creates new PnID Inference for a specific model version. This endpoint registers a new inference pipeline in Azure Machine Learning service with already trained PnID (Piping & Instrumentation Diagrams) ML model. To create new PnID Inference please provide iTwin ID and model version. All available model versions are listed in the [Model versions](/apis/pnid-to-itwin-v2/model-versions/) section.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


create-inference

OAuth access token with scope `synchronization:modify`

The user has insufficient permissions for the requested operation.

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

---

Starts PnID Inference Run after all inputs are uploaded.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


create-inference-run

---

Deletes PnID Inference.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-inference

PnID Inference Input cannot be created due to other resource being used.

---

Deletes PnID Inference Input.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-inference-input

fileId

Specified Inference cannot be deleted due to data conflict.

---

Cancels execution of PnID Inference Run.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-inference-run

---

Returns content of PnID Inference Input.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-input-content

Id of the file uploaded to PnID Inference.

Content of the inference input file returned successfully.

---

Returns all PnID Inference Inputs.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-inputs

List of PnID Inference Inputs returned successfully.

---

Returns content of PnID Inference Run Result.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-run-result-content

Content of the inference result file returned successfully.

Specified Inference Run Result was not found.

---

Returns all PnID Inference Results.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-run-results

List of PnID Inference Run results returned successfully.

---

Returns status of PnID Inference Run.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-inference-run

PnID Inference Run result returned successfully.

---

Returns all PnID Inferences in iTwin.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-itwin-inferences

Id of the iTwin that created the PnID Inference.

iTwinId

Optional max items to be sent in response.

$top

Optional token to retrieve next page in paginated response.

$continuationToken

List of PnID Inference returned successfully.

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

---

Uploads a file or replace the existing file if one already exists with the same name as PnID Inference Input.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


upload-inference-input-content

Indicates inference input content type. Supported content types for this operation are: `application/pdf`, `image/jpeg`, `image/png`, `image/bmp`.

Content-Type

Indicates inference input content filename. Content-Disposition possible header format: `attachment; filename="filename.pdf"`.

Content-Disposition

Successfully uploaded Inference Input content.

PnID Inference Input content cannot be updated due to other resource being used.

Get Inference - PnID to iTwin | iTwin Platform

Walk-through on how to run the PnID ML Model and get your Results.

PnID to iTwin

Authentication

Request

Request parameters

Request headers

Response

Response 200 OK

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Definitions