Index (Bindex Core 1.2.1-SNAPSHOT API)

B C D F G I M O P R S T U
All Classes and Interfaces|All Packages|Constant Field Values

B

BINDEX_PASSWORD_PROP_NAME - Static variable in class org.machanism.machai.bindex.core.MongoBindexRepository: Configuration property name for the MongoDB password.
BINDEX_PROPERTY_NAME - Static variable in class org.machanism.machai.bindex.core.MongoBindexRepository: MongoDB field name used to store the serialized Bindex JSON payload.
BINDEX_SCHEMA_RESOURCE - Static variable in class org.machanism.machai.bindex.core.Picker: Classpath resource path for the Bindex JSON schema.
Bindex Core - Search tag in Overview: Section
BindexFunctionTools - Class in org.machanism.machai.bindex.ai.tools: An AI tool set implementation of FunctionTools that provides discovery, resolution, and registration actions for Bindex components to large language models (LLMs).
BindexFunctionTools() - Constructor for class org.machanism.machai.bindex.ai.tools.BindexFunctionTools: Creates a new Bindex function tool set.
BindexInfo - Class in org.machanism.machai.bindex.core: Represents metadata information for a Bindex record, including its identifier, version, description, and relevance score.
BindexInfo() - Constructor for class org.machanism.machai.bindex.core.BindexInfo: Creates an empty Bindex metadata summary.
Bindex metadata model - Search tag in Overview: Section
BindexRepository - Interface in org.machanism.machai.bindex.core: Repository interface for managing Bindex records.

C

Class diagram - Search tag in Overview: Section
close() - Method in class org.machanism.machai.bindex.core.MongoBindexRepository: Closes the underlying MongoClient if this repository created it.
Configuration and runtime behavior - Search tag in Overview: Section
Core responsibilities - Search tag in Overview: Section

D

DB_URL - Static variable in class org.machanism.machai.bindex.core.MongoBindexRepository: Default MongoDB connection URL used when no repository URL is configured.
deleteBindex(Bindex) - Method in class org.machanism.machai.bindex.core.MongoBindexRepository: Deletes a Bindex document from the database.

F

find(Classification[], List<Double>, long, Double, Configurator) - Method in interface org.machanism.machai.bindex.core.BindexRepository: Finds and retrieves matching Bindex records using a combination of vector similarity search and metadata classification filtering.
find(Classification[], List<Double>, long, Double, Configurator) - Method in class org.machanism.machai.bindex.core.MongoBindexRepository: Picks matching Bindex entries for a natural-language query.

G

getBindex(String) - Method in interface org.machanism.machai.bindex.core.BindexRepository: Retrieves a Bindex entry by its unique identifier.
getBindex(String) - Method in class org.machanism.machai.bindex.core.MongoBindexRepository: Retrieves a Bindex instance from the database by its Bindex id.
getBindex(String, String, Configurator) - Method in class org.machanism.machai.bindex.ai.tools.BindexFunctionTools: Retrieves bindex metadata for a given project or library.
getCollection() - Method in class org.machanism.machai.bindex.core.MongoBindexRepository: Provides direct access to the underlying MongoDB collection.
getDescription() - Method in class org.machanism.machai.bindex.core.BindexInfo: Returns the description of the Bindex record.
getId() - Method in class org.machanism.machai.bindex.core.BindexInfo: Returns the unique identifier for the Bindex record.
getRecommendedLibraries(String, Double, int, Configurator) - Method in class org.machanism.machai.bindex.ai.tools.BindexFunctionTools: Recommends libraries based on the user's prompt or project requirements.
getRegistredId(Bindex) - Method in class org.machanism.machai.bindex.core.MongoBindexRepository: Finds the MongoDB registration identifier for the supplied Bindex.
getScore() - Method in class org.machanism.machai.bindex.core.BindexInfo: Returns the relevance score associated with the Bindex record.
getVersion() - Method in class org.machanism.machai.bindex.core.BindexInfo: Returns the version string of the Bindex record.

I

Intended usage - Search tag in Overview: Section

M

Main types - Search tag in Overview: Section
MODEL_PROP_NAME - Static variable in class org.machanism.machai.bindex.ai.tools.BindexFunctionTools: Property name for specifying the model to use in configuration.
MongoBindexRepository - Class in org.machanism.machai.bindex.core: MongoDB-backed repository for persisting and retrieving Bindex documents.
MongoBindexRepository(Configurator) - Constructor for class org.machanism.machai.bindex.core.MongoBindexRepository: Creates a repository instance backed by a MongoDB collection.

O

org.machanism.machai.bindex.ai.tools - package org.machanism.machai.bindex.ai.tools: Provides AI-facing tool implementations for discovering, retrieving, filtering, and registering Bindex metadata.
org.machanism.machai.bindex.core - package org.machanism.machai.bindex.core: Provides MongoDB-backed Bindex registration, persistence, retrieval, and semantic selection services.

P

Package structure - Search tag in Overview: Section
pick(String, long, Double, Configurator) - Method in class org.machanism.machai.bindex.core.Picker: Recommends a list of Bindex entries based on the provided prompt and minimum score.
Picker - Class in org.machanism.machai.bindex.core: Performs Bindex registration, lookup, and semantic retrieval using embeddings and MongoDB.
Picker(BindexRepository, Configurator) - Constructor for class org.machanism.machai.bindex.core.Picker: Creates a Picker backed by the configured Bindex repository and a named GenAI provider.

R

registerBindex(String, File, Configurator) - Method in class org.machanism.machai.bindex.ai.tools.BindexFunctionTools: Registers a Bindex record from a file in the project directory.
registerBindexJson(Bindex, Configurator) - Method in class org.machanism.machai.bindex.ai.tools.BindexFunctionTools: Registers a Bindex record from a JSON object.

S

save(Bindex) - Method in class org.machanism.machai.bindex.core.Picker: Saves a Bindex entry to the repository, generating and storing its embedding vector.
save(Bindex, List<Double>) - Method in interface org.machanism.machai.bindex.core.BindexRepository: Saves a Bindex entry to the repository, along with its embedding vector.
save(Bindex, List<Double>) - Method in class org.machanism.machai.bindex.core.MongoBindexRepository: Registers or replaces a Bindex entry in the repository.
setDescription(String) - Method in class org.machanism.machai.bindex.core.BindexInfo: Sets the description of the Bindex record.
setId(String) - Method in class org.machanism.machai.bindex.core.BindexInfo: Sets the unique identifier for the Bindex record.
setScore(double) - Method in class org.machanism.machai.bindex.core.BindexInfo: Sets the relevance score associated with the Bindex record.
setVersion(String) - Method in class org.machanism.machai.bindex.core.BindexInfo: Sets the version string of the Bindex record.

T

Typical workflow - Search tag in Overview: Section

U

Usage examples - Search tag in Overview: Section

B C D F G I M O P R S T U
All Classes and Interfaces|All Packages|Constant Field Values