Package com.basis.api.admin

Class BBjAdminAISchemaDocument

java.lang.Object

com.basis.api.admin.BBjAdminAISchemaDocument

All Implemented Interfaces:

Serializable

public class BBjAdminAISchemaDocument
extends Object
implements Serializable

Represents a single entry in the schema vector store; returned by BBjAdminAI.listSchemaDocuments().

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_RELATIONSHIP	Document describes a foreign-key relationship between two tables.
static final String	TYPE_TABLE	Document describes an entire database table: columns, types, primary keys, and indexes.

Constructor Summary

Constructors

Constructor	Description
BBjAdminAISchemaDocument(String id, String type, String tableName, String content)

Method Summary

Modifier and Type	Method	Description
String	getContent()	Full human-readable description of the schema element that was embedded into the vector index.
String	getId()	Unique identifier for this document within the schema vector store.
String	getTableName()	The primary table name this document is about (for relationship documents this is the source / owning table).
String	getType()	The type of schema element this document represents.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

TYPE_TABLE

public static final String TYPE_TABLE

Document describes an entire database table: columns, types, primary keys, and indexes.

See Also:

• Constant Field Values

TYPE_RELATIONSHIP

public static final String TYPE_RELATIONSHIP

Document describes a foreign-key relationship between two tables.

See Also:

• Constant Field Values

Constructor Details

BBjAdminAISchemaDocument

public BBjAdminAISchemaDocument(String id,
 String type,
 String tableName,
 String content)

Method Details

getId

public String getId()

Unique identifier for this document within the schema vector store. Used internally for updates and deletes.

getType

public String getType()

The type of schema element this document represents. One of TYPE_TABLE or TYPE_RELATIONSHIP.

getTableName

public String getTableName()

The primary table name this document is about (for relationship documents this is the source / owning table).

getContent

public String getContent()

Full human-readable description of the schema element that was embedded into the vector index. Useful for inspecting what the LLM sees as context.

toString

public String toString()

Overrides:

toString in class Object