textClassificationRequest resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a request to classify text for sensitive information types. Optionally include caller-supplied precomputed embeddingInput values so the service can skip recomputing embeddings for the text.

A textClassificationRequest is submitted to the classifyText action of the dataClassificationService resource.

Inherits from entity.

Methods

None.

Properties

Property	Type	Description
contentMetaData	classificationRequestContentMetaData	Metadata that describes the content being classified.
embeddings	embeddingInput collection	Optional caller-supplied precomputed embeddings for the text, so the service can skip recomputing them. Embeddings for models outside the allow-list are rejected with a 400.
fileExtension	String	The file extension of the content being classified.
id	String	The unique identifier for the entity. Inherited from entity.
matchTolerancesToInclude	mlClassificationMatchTolerance	The match tolerance levels to include in the classification results. The possible values are: exact, near.
scopesToRun	sensitiveTypeScope	The document scopes over which to run classification. The possible values are: fullDocument, partialDocument.
sensitiveTypeIds	String collection	The identifiers of the sensitive information types to evaluate against the text.
text	String	The text to classify.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.textClassificationRequest",
  "id": "String (identifier)",
  "text": "String",
  "embeddings": [
    {
      "@odata.type": "microsoft.graph.embeddingInput",
      "modelType": "String",
      "data": "String"
    }
  ],
  "fileExtension": "String",
  "sensitiveTypeIds": [
    "String"
  ],
  "scopesToRun": "String",
  "matchTolerancesToInclude": "String",
  "contentMetaData": {
    "@odata.type": "microsoft.graph.classificationRequestContentMetaData",
    "sourceId": "String",
    "workloadType": "String"
  }
}