Freigeben über

ContentAnalyzer Class

Package:
com.azure.ai.contentunderstanding.models
Maven Artifact:
com.azure:azure-ai-contentunderstanding:1.0.0
  • java.lang.Object
    • com.azure.ai.contentunderstanding.models.ContentAnalyzer

Implements

JsonSerializable<ContentAnalyzer>

public final class ContentAnalyzer
implements JsonSerializable<ContentAnalyzer>

Analyzer that extracts content and fields from multimodal documents.

Constructor Summary

Constructor Description
ContentAnalyzer()

Creates an instance of ContentAnalyzer class.

Method Summary

Modifier and Type Method and Description
static ContentAnalyzer fromJson(JsonReader jsonReader)

Reads an instance of ContentAnalyzer from the JsonReader.
String getAnalyzerId()

Get the analyzerId property: The unique identifier of the analyzer.
String getBaseAnalyzerId()

Get the baseAnalyzerId property: The analyzer to incrementally train from.
ContentAnalyzerConfig getConfig()

Get the config property: Analyzer configuration settings.
OffsetDateTime getCreatedAt()

Get the createdAt property: The date and time when the analyzer was created.
String getDescription()

Get the description property: A description of the analyzer.
ContentFieldSchema getFieldSchema()

Get the fieldSchema property: The schema of fields to extracted.
List<KnowledgeSource> getKnowledgeSources()

Get the knowledgeSources property: Additional knowledge sources used to enhance the analyzer.
OffsetDateTime getLastModifiedAt()

Get the lastModifiedAt property: The date and time when the analyzer was last modified.
Map<String,String> getModels()

Get the models property: Mapping of model roles to specific model names.
ProcessingLocation getProcessingLocation()

Get the processingLocation property: The location where the data may be processed.
ContentAnalyzerStatus getStatus()

Get the status property: The status of the analyzer.
SupportedModels getSupportedModels()

Get the supportedModels property: Chat completion and embedding models supported by the analyzer.
Map<String,String> getTags()

Get the tags property: Tags associated with the analyzer.
List<ResponseError> getWarnings()

Get the warnings property: Warnings encountered while creating the analyzer.
Boolean isDynamicFieldSchema()

Get the dynamicFieldSchema property: Indicates whether the result may contain additional fields outside of the defined schema.
ContentAnalyzer setBaseAnalyzerId(String baseAnalyzerId)

Set the baseAnalyzerId property: The analyzer to incrementally train from.
ContentAnalyzer setConfig(ContentAnalyzerConfig config)

Set the config property: Analyzer configuration settings.
ContentAnalyzer setDescription(String description)

Set the description property: A description of the analyzer.
ContentAnalyzer setDynamicFieldSchema(Boolean dynamicFieldSchema)

Set the dynamicFieldSchema property: Indicates whether the result may contain additional fields outside of the defined schema.
ContentAnalyzer setFieldSchema(ContentFieldSchema fieldSchema)

Set the fieldSchema property: The schema of fields to extracted.
ContentAnalyzer setKnowledgeSources(List<KnowledgeSource> knowledgeSources)

Set the knowledgeSources property: Additional knowledge sources used to enhance the analyzer.
ContentAnalyzer setModels(Map<String,String> models)

Set the models property: Mapping of model roles to specific model names.
ContentAnalyzer setProcessingLocation(ProcessingLocation processingLocation)

Set the processingLocation property: The location where the data may be processed.
ContentAnalyzer setTags(Map<String,String> tags)

Set the tags property: Tags associated with the analyzer.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ContentAnalyzer

public ContentAnalyzer()

Creates an instance of ContentAnalyzer class.

Method Details

fromJson

public static ContentAnalyzer fromJson(JsonReader jsonReader)

Reads an instance of ContentAnalyzer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ContentAnalyzer if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getAnalyzerId

public String getAnalyzerId()

Get the analyzerId property: The unique identifier of the analyzer.

Returns:

the analyzerId value.

getBaseAnalyzerId

public String getBaseAnalyzerId()

Get the baseAnalyzerId property: The analyzer to incrementally train from.

Returns:

the baseAnalyzerId value.

getConfig

public ContentAnalyzerConfig getConfig()

Get the config property: Analyzer configuration settings.

Returns:

the config value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The date and time when the analyzer was created.

Returns:

the createdAt value.

getDescription

public String getDescription()

Get the description property: A description of the analyzer.

Returns:

the description value.

getFieldSchema

public ContentFieldSchema getFieldSchema()

Get the fieldSchema property: The schema of fields to extracted.

Returns:

the fieldSchema value.

getKnowledgeSources

public List<KnowledgeSource> getKnowledgeSources()

Get the knowledgeSources property: Additional knowledge sources used to enhance the analyzer.

Returns:

the knowledgeSources value.

getLastModifiedAt

public OffsetDateTime getLastModifiedAt()

Get the lastModifiedAt property: The date and time when the analyzer was last modified.

Returns:

the lastModifiedAt value.

getModels

public Map<String,String> getModels()

Get the models property: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.

Returns:

the models value.

getProcessingLocation

public ProcessingLocation getProcessingLocation()

Get the processingLocation property: The location where the data may be processed. Defaults to global.

Returns:

the processingLocation value.

getStatus

public ContentAnalyzerStatus getStatus()

Get the status property: The status of the analyzer.

Returns:

the status value.

getSupportedModels

public SupportedModels getSupportedModels()

Get the supportedModels property: Chat completion and embedding models supported by the analyzer.

Returns:

the supportedModels value.

getTags

public Map<String,String> getTags()

Get the tags property: Tags associated with the analyzer.

Returns:

the tags value.

getWarnings

public List<ResponseError> getWarnings()

Get the warnings property: Warnings encountered while creating the analyzer.

Returns:

the warnings value.

isDynamicFieldSchema

public Boolean isDynamicFieldSchema()

Get the dynamicFieldSchema property: Indicates whether the result may contain additional fields outside of the defined schema.

Returns:

the dynamicFieldSchema value.

setBaseAnalyzerId

public ContentAnalyzer setBaseAnalyzerId(String baseAnalyzerId)

Set the baseAnalyzerId property: The analyzer to incrementally train from.

Parameters:

baseAnalyzerId - the baseAnalyzerId value to set.

Returns:

the ContentAnalyzer object itself.

setConfig

public ContentAnalyzer setConfig(ContentAnalyzerConfig config)

Set the config property: Analyzer configuration settings.

Parameters:

config - the config value to set.

Returns:

the ContentAnalyzer object itself.

setDescription

public ContentAnalyzer setDescription(String description)

Set the description property: A description of the analyzer.

Parameters:

description - the description value to set.

Returns:

the ContentAnalyzer object itself.

setDynamicFieldSchema

public ContentAnalyzer setDynamicFieldSchema(Boolean dynamicFieldSchema)

Set the dynamicFieldSchema property: Indicates whether the result may contain additional fields outside of the defined schema.

Parameters:

dynamicFieldSchema - the dynamicFieldSchema value to set.

Returns:

the ContentAnalyzer object itself.

setFieldSchema

public ContentAnalyzer setFieldSchema(ContentFieldSchema fieldSchema)

Set the fieldSchema property: The schema of fields to extracted.

Parameters:

fieldSchema - the fieldSchema value to set.

Returns:

the ContentAnalyzer object itself.

setKnowledgeSources

public ContentAnalyzer setKnowledgeSources(List<KnowledgeSource> knowledgeSources)

Set the knowledgeSources property: Additional knowledge sources used to enhance the analyzer.

Parameters:

knowledgeSources - the knowledgeSources value to set.

Returns:

the ContentAnalyzer object itself.

setModels

public ContentAnalyzer setModels(Map<String,String> models)

Set the models property: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.

Parameters:

models - the models value to set.

Returns:

the ContentAnalyzer object itself.

setProcessingLocation

public ContentAnalyzer setProcessingLocation(ProcessingLocation processingLocation)

Set the processingLocation property: The location where the data may be processed. Defaults to global.

Parameters:

processingLocation - the processingLocation value to set.

Returns:

the ContentAnalyzer object itself.

setTags

public ContentAnalyzer setTags(Map<String,String> tags)

Set the tags property: Tags associated with the analyzer.

Parameters:

tags - the tags value to set.

Returns:

the ContentAnalyzer object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to