/** * CyborgDB Service * REST API for CyborgDB: The Confidential Vector Database * * The version of the OpenAPI document: 0.17.1.dev16 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Represents a single result from a similarity search. * * A result carries either `distance` (pure vector query; smaller = more * similar) or `score` (hybrid query; the fused BM25 + vector relevance, * larger = more relevant) — never both, since a text hit has no vector * distance. * * Attributes: * id (str): The identifier of the retrieved item. * distance (Optional[float]): Distance from the query vector (smaller = more similar). * score (Optional[float]): Fused relevance score on a hybrid (`text=...`) query (larger = more relevant). * metadata (Optional[Dict[str, Any]]): Additional metadata for the result. * vector (Optional[List[float]]): The retrieved vector (if included in response). * @export * @interface QueryResultItem */ export interface QueryResultItem { /** * * @type {string} * @memberof QueryResultItem */ id: string; /** * * @type {number} * @memberof QueryResultItem */ distance?: number | null; /** * * @type {number} * @memberof QueryResultItem */ score?: number | null; /** * Arbitrary JSON object stored alongside the vector. Schemaless — the index's `metadata_schema` governs how fields are indexed, not what may be stored. Nested objects are addressable by dot-path in filters (`loc.city`); dates have no native type, store them as epoch millis. * @type {{ [key: string]: any; }} * @memberof QueryResultItem */ metadata?: { [key: string]: any; } | null; /** * * @type {Array} * @memberof QueryResultItem */ vector?: Array | null; } /** * Check if a given object implements the QueryResultItem interface. */ export declare function instanceOfQueryResultItem(value: object): value is QueryResultItem; export declare function QueryResultItemFromJSON(json: any): QueryResultItem; export declare function QueryResultItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): QueryResultItem; export declare function QueryResultItemToJSON(json: any): QueryResultItem; export declare function QueryResultItemToJSONTyped(value?: QueryResultItem | null, ignoreDiscriminator?: boolean): any;