context.h

/**
 * @file context.h
 * @author Warren Mann (warren@nonvol.io)
 * @brief Manage context file.
 * @version 0.1.0
 * @date 2024-04-27
 * @copyright Copyright (c) 2024
 * @details
 * Manage context file. The context file is used to maintain state between
 * calls to the API. The context file is a JSON file with the following
 * two standard fields:
 * 
 * "system-prompt"
 * This is the system prompt to use.
 * 
 * "history": 
 * This is an array of objects containing the query history. Each object in the
 * array has the following fields:
 * 
 *     "prompt" - The prompt for the query.
 *     "response" - The response to the query.
 *     "timestamp" - The timestamp of the query.
 * 
 * The context file may also contain other fields that are private to the API
 * being used. These fields should be stored in an object that is itself a
 * field in the top-level context object, named after the API:
 * "ollama", "openai", etc.
 * 
 * These API-specific fields are not touched by the context manager. Keeping 
 * these values up-to-date/synchronized with the API is the responsibility of
 * the API interface, using the "updates_obj" parameter of the 
 * context_update(). Values in "updates_obj" will overwrite what is in the
 * context file when context_update() runs. Values in the context file that
 * are not in "updates_obj" will be left alone.
 */

#ifndef _CONTEXT_H
#define _CONTEXT_H

#include <stdint.h>

#include <json-c/json.h>

/** @brief Default context filename. */
extern const char context_fn_default[];
/** @brief Default context directory. */
extern const char context_dir_default[];

/** @brief Add a query/response/timestamp to the context. */
extern void context_add_history(const char *prompt, const char *response, const int64_t timestamp);
/** @brief Load context from file into json object. */
extern void context_load(const char *fn);
/** @brief Create a new context. */
extern void context_new(const char *fn);
/** @brief Delete the system prompt from the context file. */
extern int context_delete_system_prompt(void);
/** @brief Dump the chat history from the context file. */
extern int context_dump_history(void);
/** @brief get an arbitrary object from a named field in the context. */
extern json_object *context_get(const char *field);
/** @brief get the AI host from the context.*/
extern const char *context_get_ai_host(void);
/** @brief Gwt the AI provider from the context. */
extern const char *context_get_ai_provider(void);
/** @brief Get the function filename from the context. */
extern const char *context_get_function_filename(void);
/** @brief Get the model from the contest. */
extern const char *context_get_model(void);
/** @brief Get the system prompt from the context. */
extern const char *context_get_system_prompt(void);
/** @brief Read the chat history from the context file. */
extern json_object *context_get_history(void);
/** @brief Get the prompt from a given history entry. */
extern const char *context_get_history_prompt(json_object *entry);
/** @brief Get the response from a given history entry. */
extern const char *context_get_history_response(json_object *entry);
/** @brief Get the timestamp from a given history entry. */
extern int64_t context_get_history_timestamp(json_object *entry);
/** @brief Set an arbitrary field to a given json object. */
extern int context_set(const char *field, json_object *obj);
/** @brief Set the AI host in the context file. */
extern int context_set_ai_host(const char *s);
/** @brief Set the AI provider in the context file. */
extern int context_set_ai_provider(const char *s);
/** @brief Set the fimction filename in the context file. */
extern int context_set_function_filename(const char *s);
/** @brief Set the model in the context file. */
extern int context_set_model(const char *s);
/** @brief Set the system prompt in the context file. */
extern int context_set_system_prompt(const char *s);
/** @brief Update the context file with new history and embeddings. */
extern void context_update(void);

#endif // _CONTEXT_H