Package ai.extend.types

Class SplitClassification

java.lang.Object

ai.extend.types.SplitClassification

public final class SplitClassification
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SplitClassification._FinalStage
static class	SplitClassification.Builder
static interface	SplitClassification.DescriptionStage
static interface	SplitClassification.IdStage
static interface	SplitClassification.TypeStage

Method Summary

Modifier and Type	Method	Description
static SplitClassification.IdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.lang.String	getDescription()
java.lang.String	getId()
java.util.Optional<java.lang.String>	getIdentifierKey()
java.lang.String	getType()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

public java.lang.String getId()

Returns:

Unique identifier for the classification. We recommend lowercase, underscore-separated format.

getType

public java.lang.String getType()

Returns:

Type identifier for the classification.

getDescription

public java.lang.String getDescription()

Returns:

A detailed description of the classification.

getIdentifierKey

public java.util.Optional<java.lang.String> getIdentifierKey()

Returns:

A natural-language rule describing how to extract a unique identifier for subdocuments of this type. For example, "Extract the invoice number from the document header".

When provided, the splitter will extract the specified identifier for each subdocument of this type and include it in the output as the identifier field. This enables merging of related subdocuments that share the same extracted identifier.

Availability: Supported on splitting_light >= 1.3.0 and splitting_performance >= 1.5.0. If provided on older versions, this field is accepted but ignored.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static SplitClassification.IdStage builder()