Package org.machanism.machai.schema

Class Bindex

java.lang.Object

org.machanism.machai.schema.Bindex

@Generated("jsonschema2pojo")
public class Bindex
extends Object

Bindex

A schema to describe artifacts (e.g., libraries) for automatic recognition and integration with GenAI engines.

Constructor Summary

Constructors

Constructor	Description
Bindex()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
List<Author>	getAuthors()	(Required)
Classification	getClassification()	Categorizes the artifact by type, domain, and supported languages.
List<Constructor>	getConstructors()	This section should contain information about how the object (service) is created and how it is configured before use.
List<Customization>	getCustomizations()	Extension or customization points for developers to extend or modify the artifact's functionality.
List<String>	getDependencies()	A list of artifact dependencies.
String	getDescription()	A critical property for bindex.json that is used to generate embeddings for semantic search in assembling customer applications.
List<Example__4>	getExamples()	General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used.
List<Feature>	getFeatures()	The primary functions or capabilities provided by the artifact.
String	getId()	A unique identifier for the artifact.
String	getLicense()	License type (e.g., MIT, Apache 2.0, etc.).
Location	getLocation()	Details about the artifact's storage location, repository type, and metadata.
String	getName()	The full name of the artifact or library.
List<Stud>	getStuds()	A list of interfaces or abstract classes defined in this artifact, intended for implementation or extension by other modules to support forking, plugin, or extension scenarios.
String	getVersion()	Version of the artifact (e.g., semantic versioning, tag, or hash).
int	hashCode()
void	setAdditionalProperty(String name, Object value)
void	setAuthors(List<Author> authors)	(Required)
void	setClassification(Classification classification)	Categorizes the artifact by type, domain, and supported languages.
void	setConstructors(List<Constructor> constructors)	This section should contain information about how the object (service) is created and how it is configured before use.
void	setCustomizations(List<Customization> customizations)	Extension or customization points for developers to extend or modify the artifact's functionality.
void	setDependencies(List<String> dependencies)	A list of artifact dependencies.
void	setDescription(String description)	A critical property for bindex.json that is used to generate embeddings for semantic search in assembling customer applications.
void	setExamples(List<Example__4> examples)	General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used.
void	setFeatures(List<Feature> features)	The primary functions or capabilities provided by the artifact.
void	setId(String id)	A unique identifier for the artifact.
void	setLicense(String license)	License type (e.g., MIT, Apache 2.0, etc.).
void	setLocation(Location location)	Details about the artifact's storage location, repository type, and metadata.
void	setName(String name)	The full name of the artifact or library.
void	setStuds(List<Stud> studs)	A list of interfaces or abstract classes defined in this artifact, intended for implementation or extension by other modules to support forking, plugin, or extension scenarios.
void	setVersion(String version)	Version of the artifact (e.g., semantic versioning, tag, or hash).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Bindex

public Bindex()

Method Details

getId

public String getId()

A unique identifier for the artifact. (Required)

setId

public void setId(String id)

A unique identifier for the artifact. (Required)

getName

public String getName()

The full name of the artifact or library. For Maven artifacts, use groupId:artifactId. (Required)

setName

public void setName(String name)

The full name of the artifact or library. For Maven artifacts, use groupId:artifactId. (Required)

getVersion

public String getVersion()

Version of the artifact (e.g., semantic versioning, tag, or hash). (Required)

setVersion

public void setVersion(String version)

Version of the artifact (e.g., semantic versioning, tag, or hash). (Required)

getLocation

public Location getLocation()

Details about the artifact's storage location, repository type, and metadata. (Required)

setLocation

public void setLocation(Location location)

Details about the artifact's storage location, repository type, and metadata. (Required)

getDescription

public String getDescription()

A critical property for bindex.json that is used to generate embeddings for semantic search in assembling customer applications. The description must include all relevant information to support accurate and comprehensive embeddings. This should be generated based on project description info and any additional contextual information from the project, if required, such as dependencies, features, and domain-specific details. Providing a detailed and representative description is essential for ensuring high-quality search results. (Required)

setDescription

public void setDescription(String description)

A critical property for bindex.json that is used to generate embeddings for semantic search in assembling customer applications. The description must include all relevant information to support accurate and comprehensive embeddings. This should be generated based on project description info and any additional contextual information from the project, if required, such as dependencies, features, and domain-specific details. Providing a detailed and representative description is essential for ensuring high-quality search results. (Required)

getAuthors

public List<Author> getAuthors()

(Required)

setAuthors

public void setAuthors(List<Author> authors)

(Required)

getLicense

public String getLicense()

License type (e.g., MIT, Apache 2.0, etc.). (Required)

setLicense

public void setLicense(String license)

License type (e.g., MIT, Apache 2.0, etc.). (Required)

getClassification

public Classification getClassification()

Categorizes the artifact by type, domain, and supported languages. (Required)

setClassification

public void setClassification(Classification classification)

Categorizes the artifact by type, domain, and supported languages. (Required)

getConstructors

public List<Constructor> getConstructors()

This section should contain information about how the object (service) is created and how it is configured before use. (Required)

setConstructors

public void setConstructors(List<Constructor> constructors)

This section should contain information about how the object (service) is created and how it is configured before use. (Required)

getFeatures

public List<Feature> getFeatures()

The primary functions or capabilities provided by the artifact. (Required)

setFeatures

public void setFeatures(List<Feature> features)

The primary functions or capabilities provided by the artifact. (Required)

getCustomizations

public List<Customization> getCustomizations()

Extension or customization points for developers to extend or modify the artifact's functionality.

setCustomizations

public void setCustomizations(List<Customization> customizations)

Extension or customization points for developers to extend or modify the artifact's functionality.

getStuds

public List<Stud> getStuds()

A list of interfaces or abstract classes defined in this artifact, intended for implementation or extension by other modules to support forking, plugin, or extension scenarios.

setStuds

public void setStuds(List<Stud> studs)

A list of interfaces or abstract classes defined in this artifact, intended for implementation or extension by other modules to support forking, plugin, or extension scenarios.

getExamples

public List<Example__4> getExamples()

General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used.

setExamples

public void setExamples(List<Example__4> examples)

General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used.

getDependencies

public List<String> getDependencies()

A list of artifact dependencies.

setDependencies

public void setDependencies(List<String> dependencies)

A list of artifact dependencies.

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
 Object value)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object