cactus-react-native 1.5.0 → 1.7.0

package/ios/cactus.xcframework/ios-arm64/cactus.framework/Headers/cactus_ffi.h

@@ -6,11 +6,11 @@
 #include <stdbool.h>
 
 #if __GNUC__ >= 4
-  #define CACTUS_FFI_EXPORT __attribute__ ((visibility ("default")))
-  #define CACTUS_FFI_LOCAL  __attribute__ ((visibility ("hidden")))
+    #define CACTUS_FFI_EXPORT __attribute__((visibility("default")))
+    #define CACTUS_FFI_LOCAL  __attribute__((visibility("hidden")))
 #else
-  #define CACTUS_FFI_EXPORT
-  #define CACTUS_FFI_LOCAL
+    #define CACTUS_FFI_EXPORT
+    #define CACTUS_FFI_LOCAL
 #endif
 
 #ifdef __cplusplus
@@ -18,20 +18,30 @@ extern "C" {
 #endif
 
 typedef void* cactus_model_t;
+typedef void* cactus_index_t;
+typedef void* cactus_stream_transcribe_t;
 
 typedef void (*cactus_token_callback)(const char* token, uint32_t token_id, void* user_data);
 
-CACTUS_FFI_EXPORT cactus_model_t cactus_init(const char* model_path, size_t context_size, const char* corpus_dir);
+CACTUS_FFI_EXPORT cactus_model_t cactus_init(
+    const char* model_path,
+    const char* corpus_dir,                 // optional: NULL if no RAG corpus
+    bool cache_index                        // false = always rebuild index, true = load cached if available
+);
+
+CACTUS_FFI_EXPORT void cactus_destroy(cactus_model_t model);
+CACTUS_FFI_EXPORT void cactus_reset(cactus_model_t model);
+CACTUS_FFI_EXPORT void cactus_stop(cactus_model_t model);
 
 CACTUS_FFI_EXPORT int cactus_complete(
     cactus_model_t model,
     const char* messages_json,
     char* response_buffer,
     size_t buffer_size,
-    const char* options_json,
-    const char* tools_json,
-    cactus_token_callback callback,
-    void* user_data
+    const char* options_json,               // optional
+    const char* tools_json,                 // optional
+    cactus_token_callback callback,         // optional
+    void* user_data                         // optional
 );
 
 CACTUS_FFI_EXPORT int cactus_tokenize(
@@ -53,45 +63,38 @@ CACTUS_FFI_EXPORT int cactus_score_window(
     size_t buffer_size
 );
 
-
 CACTUS_FFI_EXPORT int cactus_transcribe(
     cactus_model_t model,
-    const char* audio_file_path,
+    const char* audio_file_path,            // NULL if using pcm_buffer
     const char* prompt,
     char* response_buffer,
     size_t buffer_size,
-    const char* options_json,
-    cactus_token_callback callback,
-    void* user_data,
-    const uint8_t* pcm_buffer,
+    const char* options_json,               // optional
+    cactus_token_callback callback,         // optional
+    void* user_data,                        // optional
+    const uint8_t* pcm_buffer,              // NULL if using audio_file_path
     size_t pcm_buffer_size
 );
 
-typedef void* cactus_stream_transcribe_t;
-
-CACTUS_FFI_EXPORT cactus_stream_transcribe_t cactus_stream_transcribe_init(cactus_model_t model);
-
-CACTUS_FFI_EXPORT int cactus_stream_transcribe_insert(
-    cactus_stream_transcribe_t stream,
-    const uint8_t* pcm_buffer,
-    size_t pcm_buffer_size
+CACTUS_FFI_EXPORT cactus_stream_transcribe_t cactus_stream_transcribe_start(
+    cactus_model_t model,
+    const char* options_json                // optional
 );
 
 CACTUS_FFI_EXPORT int cactus_stream_transcribe_process(
     cactus_stream_transcribe_t stream,
+    const uint8_t* pcm_buffer,
+    size_t pcm_buffer_size,
     char* response_buffer,
-    size_t buffer_size,
-    const char* options_json
+    size_t buffer_size
 );
 
-CACTUS_FFI_EXPORT int cactus_stream_transcribe_finalize(
+CACTUS_FFI_EXPORT int cactus_stream_transcribe_stop(
     cactus_stream_transcribe_t stream,
     char* response_buffer,
     size_t buffer_size
 );
 
-CACTUS_FFI_EXPORT void cactus_stream_transcribe_destroy(cactus_stream_transcribe_t stream);
-
 CACTUS_FFI_EXPORT int cactus_embed(
     cactus_model_t model,
     const char* text,
@@ -117,19 +120,24 @@ CACTUS_FFI_EXPORT int cactus_audio_embed(
     size_t* embedding_dim
 );
 
-CACTUS_FFI_EXPORT void cactus_reset(cactus_model_t model);
-
-CACTUS_FFI_EXPORT void cactus_stop(cactus_model_t model);
-
-CACTUS_FFI_EXPORT void cactus_destroy(cactus_model_t model);
-
-CACTUS_FFI_EXPORT const char* cactus_get_last_error(void);
-
-CACTUS_FFI_EXPORT void cactus_set_telemetry_token(const char* token);
+CACTUS_FFI_EXPORT int cactus_vad(
+    cactus_model_t model,
+    const char* audio_file_path,
+    char* response_buffer,
+    size_t buffer_size,
+    const char* options_json,
+    const uint8_t* pcm_buffer,
+    size_t pcm_buffer_size
+);
 
-CACTUS_FFI_EXPORT void cactus_set_pro_key(const char* pro_key);
+CACTUS_FFI_EXPORT int cactus_rag_query(
+    cactus_model_t model,
+    const char* query,
+    char* response_buffer,
+    size_t buffer_size,
+    size_t top_k
+);
 
-typedef void* cactus_index_t;
 
 CACTUS_FFI_EXPORT cactus_index_t cactus_index_init(
     const char* index_dir,
@@ -140,7 +148,7 @@ CACTUS_FFI_EXPORT int cactus_index_add(
     cactus_index_t index,
     const int* ids,
     const char** documents,
-    const char** metadatas,
+    const char** metadatas,                 // optional: can be NULL
     const float** embeddings,
     size_t count,
     size_t embedding_dim
@@ -169,7 +177,7 @@ CACTUS_FFI_EXPORT int cactus_index_query(
     const float** embeddings,
     size_t embeddings_count,
     size_t embedding_dim,
-    const char* options_json,
+    const char* options_json,               // optional
     int** id_buffers,
     size_t* id_buffer_sizes,
     float** score_buffers,
@@ -177,11 +185,14 @@ CACTUS_FFI_EXPORT int cactus_index_query(
 );
 
 CACTUS_FFI_EXPORT int cactus_index_compact(cactus_index_t index);
-
 CACTUS_FFI_EXPORT void cactus_index_destroy(cactus_index_t index);
 
+CACTUS_FFI_EXPORT const char* cactus_get_last_error(void);
+
+CACTUS_FFI_EXPORT void cactus_set_telemetry_environment(const char* framework, const char* cache_location);
+
 #ifdef __cplusplus
 }
 #endif
 
-#endif 
+#endif // CACTUS_FFI_H