Package org.machanism.machai.schema
Class Bindex
java.lang.Object
org.machanism.machai.schema.Bindex
Bindex
A schema to describe artifacts (e.g., libraries) for automatic recognition and integration with GenAI engines.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean(Required)Categorizes the artifact by type, domain, and supported languages.This section should contain information about how the object (service) is created and how it is configured before use.Extension or customization points for developers to extend or modify the artifact's functionality.A list of artifact dependencies.A critical property for bindex.json that is used to generate embeddings for semantic search in assembling customer applications.General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used.The primary functions or capabilities provided by the artifact.getId()A unique identifier for the artifact.License type (e.g., MIT, Apache 2.0, etc.).Details about the artifact's storage location, repository type, and metadata.getName()The full name of the artifact or library.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.Version of the artifact (e.g., semantic versioning, tag, or hash).inthashCode()voidsetAdditionalProperty(String name, Object value) voidsetAuthors(List<Author> authors) (Required)voidsetClassification(Classification classification) Categorizes the artifact by type, domain, and supported languages.voidsetConstructors(List<Constructor> constructors) This section should contain information about how the object (service) is created and how it is configured before use.voidsetCustomizations(List<Customization> customizations) Extension or customization points for developers to extend or modify the artifact's functionality.voidsetDependencies(List<String> dependencies) A list of artifact dependencies.voidsetDescription(String description) A critical property for bindex.json that is used to generate embeddings for semantic search in assembling customer applications.voidsetExamples(List<Example__4> examples) General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used.voidsetFeatures(List<Feature> features) The primary functions or capabilities provided by the artifact.voidA unique identifier for the artifact.voidsetLicense(String license) License type (e.g., MIT, Apache 2.0, etc.).voidsetLocation(Location location) Details about the artifact's storage location, repository type, and metadata.voidThe full name of the artifact or library.voidA 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.voidsetVersion(String version) Version of the artifact (e.g., semantic versioning, tag, or hash).toString()
-
Constructor Details
-
Bindex
public Bindex()
-
-
Method Details
-
getId
A unique identifier for the artifact. (Required) -
setId
A unique identifier for the artifact. (Required) -
getName
The full name of the artifact or library. For Maven artifacts, use groupId:artifactId. (Required) -
setName
The full name of the artifact or library. For Maven artifacts, use groupId:artifactId. (Required) -
getVersion
Version of the artifact (e.g., semantic versioning, tag, or hash). (Required) -
setVersion
Version of the artifact (e.g., semantic versioning, tag, or hash). (Required) -
getLocation
Details about the artifact's storage location, repository type, and metadata. (Required) -
setLocation
Details about the artifact's storage location, repository type, and metadata. (Required) -
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
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
-
setAuthors
-
getLicense
License type (e.g., MIT, Apache 2.0, etc.). (Required) -
setLicense
License type (e.g., MIT, Apache 2.0, etc.). (Required) -
getClassification
Categorizes the artifact by type, domain, and supported languages. (Required) -
setClassification
Categorizes the artifact by type, domain, and supported languages. (Required) -
getConstructors
This section should contain information about how the object (service) is created and how it is configured before use. (Required) -
setConstructors
This section should contain information about how the object (service) is created and how it is configured before use. (Required) -
getFeatures
-
setFeatures
-
getCustomizations
Extension or customization points for developers to extend or modify the artifact's functionality. -
setCustomizations
Extension or customization points for developers to extend or modify the artifact's functionality. -
getStuds
-
setStuds
-
getExamples
General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used. -
setExamples
General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used. -
getDependencies
-
setDependencies
-
getAdditionalProperties
-
setAdditionalProperty
-
toString
-
hashCode
-
equals
-