Package com.azure.ai.documentintelligence.models

Class ComposeDocumentModelRequest

java.lang.Object
com.azure.ai.documentintelligence.models.ComposeDocumentModelRequest
All Implemented Interfaces:
com.azure.json.JsonSerializable<ComposeDocumentModelRequest>
public final class ComposeDocumentModelRequest extends Object implements com.azure.json.JsonSerializable<ComposeDocumentModelRequest>
Request body to create a composed document model from component document models.

  • Constructor Details

    • ComposeDocumentModelRequest

      public ComposeDocumentModelRequest(String modelId, String classifierId, Map<String,DocumentTypeDetails> docTypes)
      Creates an instance of ComposeDocumentModelRequest class.
      Parameters:
      modelId - the modelId value to set.
      classifierId - the classifierId value to set.
      docTypes - the docTypes value to set.

  • Method Details

    • getModelId

      public String getModelId()
      Get the modelId property: Unique document model name.
      Returns:
      the modelId value.

    • getDescription

      public String getDescription()
      Get the description property: Document model description.
      Returns:
      the description value.

    • setDescription

      public ComposeDocumentModelRequest setDescription(String description)
      Set the description property: Document model description.
      Parameters:
      description - the description value to set.
      Returns:
      the ComposeDocumentModelRequest object itself.

    • getClassifierId

      public String getClassifierId()
      Get the classifierId property: Custom classifier to split and classify the input file.
      Returns:
      the classifierId value.

    • getSplit

      public SplitMode getSplit()
      Get the split property: File splitting behavior.
      Returns:
      the split value.

    • setSplit

      public ComposeDocumentModelRequest setSplit(SplitMode split)
      Set the split property: File splitting behavior.
      Parameters:
      split - the split value to set.
      Returns:
      the ComposeDocumentModelRequest object itself.

    • getDocTypes

      public Map<String,DocumentTypeDetails> getDocTypes()
      Get the docTypes property: Dictionary mapping supported docTypes to the corresponding document models.
      Returns:
      the docTypes value.

    • getTags

      public Map<String,String> getTags()
      Get the tags property: List of key-value tag attributes associated with the document model.
      Returns:
      the tags value.

    • setTags

      public ComposeDocumentModelRequest setTags(Map<String,String> tags)
      Set the tags property: List of key-value tag attributes associated with the document model.
      Parameters:
      tags - the tags value to set.
      Returns:
      the ComposeDocumentModelRequest object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ComposeDocumentModelRequest>
      Throws:
      IOException

    • fromJson

      public static ComposeDocumentModelRequest fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ComposeDocumentModelRequest from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ComposeDocumentModelRequest if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the ComposeDocumentModelRequest.