Actions and filters available to developers extending Wyregraf. This reference is generated from the plugin source on each release.
Actions (43) #
pngc_wyregraf_activatepngx_logpngx_wyregraf_access_profiles_deletedpngx_wyregraf_access_profiles_embeddings_savedpngx_wyregraf_access_profiles_llm_savedpngx_wyregraf_access_profiles_updatedpngx_wyregraf_accuracy_provider_callpngx_wyregraf_add_metaboxpngx_wyregraf_admin_assetspngx_wyregraf_after_embeddings_createdpngx_wyregraf_before_update_access_profilespngx_wyregraf_chat_message_receivedpngx_wyregraf_chat_type_handler_{$chat_type}pngx_wyregraf_deactivatepngx_wyregraf_embeddings_add_metaboxpngx_wyregraf_embeddings_meta_messagespngx_wyregraf_embeddings_source_{$this->source_id}_pre_create_vector_store_{$vectordb}pngx_wyregraf_embeddings_source_all_pre_create_vector_store_{$vectordb}pngx_wyregraf_embeddings_source_delete_vector_store_{$vectordb}pngx_wyregraf_llm_usagepngx_wyregraf_meta_messagespngx_wyregraf_plugin_failed_to_loadpngx_wyregraf_plugin_loadedpngx_wyregraf_pro_after_evaluation_agentpngx_wyregraf_pro_after_fallback_agentpngx_wyregraf_pro_agent_add_metaboxpngx_wyregraf_pro_agent_meta_messagespngx_wyregraf_pro_before_evaluation_agentpngx_wyregraf_pro_before_fallback_agentpngx_wyregraf_pro_networks_add_metaboxpngx_wyregraf_pro_networks_meta_messagespngx_wyregraf_pro_plugin_loadedpngx_wyregraf_reindex_skipped_unchangedpngx_wyregraf_retrieval_chunk_writtenpngx_wyregraf_vector_store_after_from_textswyregraf_pro_chat_group_before_id_emptiedwyregraf_pro_chat_group_emptiedwyregraf_pro_chat_group_loaded_from_sessionwyregraf_pro_chat_group_set_group_id_cookieswyregraf_pro_chat_group_updatedwyregraf_pro_group_chat_after_chat_group_id_createdwyregraf_pro_load_chat_group_from_sessionwyregraf_retrieval_empty
pngc_wyregraf_activate #
do_action( 'pngc_wyregraf_activate' )Fires on Activation of Wyregraf
Since 0.1.0 · Source: Wyregraf/src/Plugin.php
pngx_log #
do_action( 'pngx_log', string $level, string $source, array $context )Fires when Wyregraf or the Pngx engine records a log entry.
Wyregraf attaches no listener of its own. Hook this action to route entries to a logger or monitoring service. The context array always carries an ‘action’ key naming the operation and may carry further keys such as ‘reason’, ‘error’, ‘exception’ or the related post and chat IDs.
$level(string) — The log level: ‘debug’, ‘warning’ or ‘error’.$source(string) — The component that logged the entry.$context(array) — Structured details about the entry.
Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_access_profiles_deleted #
do_action( 'pngx_wyregraf_access_profiles_deleted', \Abstract_Access_Profiles $access_profiles, (string|mixed)[] $properties )Fires once a Access Profile is deleted.
$access_profiles(\Abstract_Access_Profiles) — An access profile object.$properties((string|mixed)[]) — An access profile properties array.
Since 0.2.0 · Source: Wyregraf/src/Access_Profiles/Abstract_Access_Profiles_AJAX.php
pngx_wyregraf_access_profiles_embeddings_saved #
do_action( 'pngx_wyregraf_access_profiles_embeddings_saved', \Abstract_Access_Profiles $access_profiles, (string|mixed)[] $properties )Fires once a Access Profile is saved.
$access_profiles(\Abstract_Access_Profiles) — An access profile object.$properties((string|mixed)[]) — An access profile properties array.
Since 0.2.0 · Source: Wyregraf/src/Embeddings/Profiles.php
pngx_wyregraf_access_profiles_llm_saved #
do_action( 'pngx_wyregraf_access_profiles_llm_saved', \Abstract_Access_Profiles $access_profiles, (string|mixed)[] $properties )Fires once a Access Profile is saved.
$access_profiles(\Abstract_Access_Profiles) — An access profile object.$properties((string|mixed)[]) — An access profile properties array.
Since 0.2.0 · Source: Wyregraf/src/LLM/Profiles.php
pngx_wyregraf_access_profiles_updated #
do_action( 'pngx_wyregraf_access_profiles_updated', \Abstract_Access_Profiles $access_profiles, (string|mixed)[] $properties )Fires once a Access Profile is updated.
$access_profiles(\Abstract_Access_Profiles) — An access profile object.$properties((string|mixed)[]) — An access profile properties array.
Since 0.2.0 · Source: Wyregraf/src/Access_Profiles/Abstract_Access_Profiles_AJAX.php
pngx_wyregraf_accuracy_provider_call #
do_action( 'pngx_wyregraf_accuracy_provider_call', array<string,mixed> $call )Fires after each accuracy-profile provider request so usage stays observable.
$call(array<string,mixed>) — Call details.
Source: Wyregraf/src/Retrieval/Query_Planner.php
pngx_wyregraf_add_metabox #
do_action( 'pngx_wyregraf_add_metabox', int $post_id )Additional Post Meta Hook
$post_id(int) — The post id.
Since 0.1.0 · Source: Wyregraf/src/Chats/Meta.php
pngx_wyregraf_admin_assets #
do_action( 'pngx_wyregraf_admin_assets' )Hook to load additional admin styles and scripts.
Since 0.1.0 · Source: Wyregraf/src/Assets/Provider.php
pngx_wyregraf_after_embeddings_created #
do_action( 'pngx_wyregraf_after_embeddings_created', (string|mixed)[] $data )Hook runs after embeddings are created.
$data((string|mixed)[]) — An array of data to create embeddings.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Profiles.php
pngx_wyregraf_before_update_access_profiles #
do_action( 'pngx_wyregraf_before_update_access_profiles', array<string,mixed> $, (string)[] $profile_data, string $service_id )Fires after before the profile list is updated for an API.
$(array<string,mixed>) — An array of Profiles formatted for options dropdown.$profile_data((string)[]) — The array of data for a profile to add to the list.$service_id(string) — The id of the API in use.
Since 0.1.0 · Source: Wyregraf/src/Access_Profiles/Abstract_Access_Profiles.php
pngx_wyregraf_chat_message_received #
do_action( 'pngx_wyregraf_chat_message_received', int $chat_post_id, string $message, string $chat_type )Fires when a validated chat message is about to be dispatched to its handler.
Runs after the nonce, quota, and validation gates for every chat type (chat / retrieval / agents), so it is a reliable server-side record of demand — one fire per user message — independent of client-side message persistence. A message whose handler later errors still counts as asked.
$chat_post_id(int) — The chat id.$message(string) — The visitor’s message text.$chat_type(string) — The chat type: chat | retrieval | agents.
Since TBD · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_chat_type_handler_{$chat_type} #
do_action( 'pngx_wyregraf_chat_type_handler_{$chat_type}', int $chat_post_id, string $message, \Embeddings_Profiles $embeddings_profile, \LLM_Profiles $llm_profile, (string|mixed)[] $chat_history, (string|mixed)[] $chat_sources )Hook for handling the chat types.
$chat_post_id(int) — The chat id.$message(string) — The message to use with the services.$embeddings_profile(\Embeddings_Profiles) — An instance of the Embeddings Service Profiles.$llm_profile(\LLM_Profiles) — An instance of the LLM Service Profiles.$chat_history((string|mixed)[]) — An array of the chat history.$chat_sources((string|mixed)[]) — An array of the chat sources.
Since 0.1.0 · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_deactivate #
do_action( 'pngx_wyregraf_deactivate' )Fires on deactivation of Wyregraf
Since 0.1.0 · Source: Wyregraf/src/Plugin.php
pngx_wyregraf_embeddings_add_metabox #
do_action( 'pngx_wyregraf_embeddings_add_metabox', int $post_id )Additional Post Meta Hook
$post_id(int) — The post id.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Meta.php
pngx_wyregraf_embeddings_meta_messages #
do_action( 'pngx_wyregraf_embeddings_meta_messages', int $post_id )Hook to display messages below the title on the post editor.
$post_id(int) — The post id.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Meta.php
pngx_wyregraf_embeddings_source_{$this->source_id}_pre_create_vector_store_{$vectordb} #
do_action( 'pngx_wyregraf_embeddings_source_{$this->source_id}_pre_create_vector_store_{$vectordb}', int $content_id, int[] $term_ids, \Profiles $embeddings_profile, int $embeddings_post_id )Action pre creating embeddings.
$content_id(int) — The content post id.$term_ids(int[]) — An array of term ids.$embeddings_profile(\Profiles) — An instance of the Embeddings profiles.$embeddings_post_id(int) — The embeddings post id.
Since 0.1.0 · Source: Wyregraf/src/Sources/Posts/Controller.php
pngx_wyregraf_embeddings_source_all_pre_create_vector_store_{$vectordb} #
do_action( 'pngx_wyregraf_embeddings_source_all_pre_create_vector_store_{$vectordb}', int $content_id, int[] $term_ids, \Profiles $embeddings_profile, int $embeddings_post_id )Action pre creating embeddings for all sources.
$content_id(int) — The content post id.$term_ids(int[]) — An array of term ids.$embeddings_profile(\Profiles) — An instance of the Embeddings profiles.$embeddings_post_id(int) — The embeddings post id.
Since 0.1.0 · Source: Wyregraf/src/Sources/Posts/Controller.php
pngx_wyregraf_embeddings_source_delete_vector_store_{$vectordb} #
do_action( 'pngx_wyregraf_embeddings_source_delete_vector_store_{$vectordb}', int $content_id, int[] $term_ids, \Profiles $embeddings_profile, int $embeddings_post_id )Action run to delete embeddings from source post.
$content_id(int) — The content post id.$term_ids(int[]) — An array of term ids.$embeddings_profile(\Profiles) — An instance of the Embeddings profiles.$embeddings_post_id(int) — The embeddings post id.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Controller.php
pngx_wyregraf_llm_usage #
do_action( 'pngx_wyregraf_llm_usage', array $usage, string $model, string $service )Fires after every paid LLM response with the provider usage payload.
$usage(array) — Raw provider usage (prompt/completion/total_tokens).$model(string) — The model name.$service(string) — The service id (openai|anthropic).
Since TBD · Source: Wyregraf/src/Libraries/Kambo/Langchain/LLMs/OpenAIChat.php
pngx_wyregraf_meta_messages #
do_action( 'pngx_wyregraf_meta_messages', int $post_id )Hook to display messages below the title on the post editor.
$post_id(int) — The post id.
Since 0.1.0 · Source: Wyregraf/src/Chats/Meta.php
pngx_wyregraf_plugin_failed_to_load #
do_action( 'pngx_wyregraf_plugin_failed_to_load' )Fires if Wyregraf cannot load due to compatibility or other problems.
Source: Wyregraf/src/Plugin.php
pngx_wyregraf_plugin_loaded #
do_action( 'pngx_wyregraf_plugin_loaded' )Fires once Wyregraf Vector has completed basic setup.
Since 0.1.0 · Source: Wyregraf/src/Plugin.php
pngx_wyregraf_pro_after_evaluation_agent #
do_action( 'pngx_wyregraf_pro_after_evaluation_agent', \Abstract_Agent $evaluation_agent, \Output $output )Action after evaluation agent processes.
$evaluation_agent(\Abstract_Agent) — The evaluation agent.$output(\Output) — The output object.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Pipeline/Agent_Handler.php
pngx_wyregraf_pro_after_fallback_agent #
do_action( 'pngx_wyregraf_pro_after_fallback_agent', \Abstract_Agent $fallback_agent, \Output $output )Action after fallback agent processes.
$fallback_agent(\Abstract_Agent) — The fallback agent.$output(\Output) — The output object.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Pipeline/Agent_Handler.php
pngx_wyregraf_pro_agent_add_metabox #
do_action( 'pngx_wyregraf_pro_agent_add_metabox', int $post_id )Additional Post Meta Hook
$post_id(int) — The post id.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Meta.php
pngx_wyregraf_pro_agent_meta_messages #
do_action( 'pngx_wyregraf_pro_agent_meta_messages', int $post_id )Hook to display messages below the title on the post editor.
$post_id(int) — The post id.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Meta.php
pngx_wyregraf_pro_before_evaluation_agent #
do_action( 'pngx_wyregraf_pro_before_evaluation_agent', \Abstract_Agent $evaluation_agent, \Output $output )Action before evaluation agent processes.
$evaluation_agent(\Abstract_Agent) — The evaluation agent.$output(\Output) — The output object.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Pipeline/Agent_Handler.php
pngx_wyregraf_pro_before_fallback_agent #
do_action( 'pngx_wyregraf_pro_before_fallback_agent', \Abstract_Agent $fallback_agent, \Output $output )Action before fallback agent processes.
$fallback_agent(\Abstract_Agent) — The fallback agent.$output(\Output) — The output object.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Pipeline/Agent_Handler.php
pngx_wyregraf_pro_networks_add_metabox #
do_action( 'pngx_wyregraf_pro_networks_add_metabox', int $post_id )Additional Post Meta Hook
$post_id(int) — The post id.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Meta.php
pngx_wyregraf_pro_networks_meta_messages #
do_action( 'pngx_wyregraf_pro_networks_meta_messages', int $post_id )Hook to display messages below the title on the post editor.
$post_id(int) — The post id.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Meta.php
pngx_wyregraf_pro_plugin_loaded #
do_action( 'pngx_wyregraf_pro_plugin_loaded' )Fires once Wyregraf Pro has completed basic setup.
Since 0.1.0 · Source: Wyregraf_Pro/src/Pro.php
pngx_wyregraf_reindex_skipped_unchanged #
do_action( 'pngx_wyregraf_reindex_skipped_unchanged', int $content_id, int $embeddings_post_id )Fires when an event-driven re-index is skipped because the content is unchanged.
$content_id(int) — The source content post id.$embeddings_post_id(int) — The embeddings profile post id.
Since 0.7.0 · Source: Wyregraf/src/Sources/Posts/Controller.php
pngx_wyregraf_retrieval_chunk_written #
do_action( 'pngx_wyregraf_retrieval_chunk_written', int $parent_id, int $chunk_embeddings_id, int $embeddings_post_id, int $content_id, string $embeddings_type )Fires after a retrieval chunk and its terms and metadata have been saved.
$parent_id(int) — The parent embedding ID.$chunk_embeddings_id(int) — The saved chunk ID.$embeddings_post_id(int) — The embeddings (source) post ID.$content_id(int) — The source content ID.$embeddings_type(string) — The embeddings type of the chunk.
Source: Wyregraf/src/Vector_Stores/Abstract_Collection.php
pngx_wyregraf_vector_store_after_from_texts #
do_action( 'pngx_wyregraf_vector_store_after_from_texts', array $embedding_ids, int $embeddings_post_id, \VectorStore $self, array $texts, array|null $metadata, array $additionalArguments )Fires after the vector store is created from texts.
$embedding_ids(array) — Array of embedding post ids for the added parent texts.$embeddings_post_id(int) — The embeddings post id.$self(\VectorStore) — The VectorStore instance.$texts(array) — Array of text strings.$metadata(array|null) — Optional metadata for each text.$additionalArguments(array) — Additional arguments.
Since 0.5.0 · Source: Wyregraf/src/Vector_Stores/Simple_MySQL/Vector_Store.php
wyregraf_pro_chat_group_before_id_emptied #
do_action( 'wyregraf_pro_chat_group_before_id_emptied', bool $clear_persistent_chats, bool $delete_database_records )Fires before chats emptied.
$clear_persistent_chats(bool) — Whether to clear the persistent chats.$delete_database_records(bool) — Whether to delete chat records from database.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_pro_chat_group_emptied #
do_action( 'wyregraf_pro_chat_group_emptied', bool $clear_persistent_chats, bool $delete_database_records )Fires after chats emptied.
$clear_persistent_chats(bool) — Whether to clear the persistent chats.$delete_database_records(bool) — Whether chat records were deleted from database.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_pro_chat_group_loaded_from_session #
do_action( 'wyregraf_pro_chat_group_loaded_from_session', \Chats $this )Fires after chat loaded from session.
$this(\Chats) — An instance of the chats object.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_pro_chat_group_set_group_id_cookies #
do_action( 'wyregraf_pro_chat_group_set_group_id_cookies', bool $ )Action fires when setting chats cookies.
$(bool) — Whether the chats cookies should set.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_pro_chat_group_updated #
do_action( 'wyregraf_pro_chat_group_updated' )Action fires when updating chats session.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_pro_group_chat_after_chat_group_id_created #
do_action( 'wyregraf_pro_group_chat_after_chat_group_id_created' )Action fires when creating a new chats id.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_pro_load_chat_group_from_session #
do_action( 'wyregraf_pro_load_chat_group_from_session' )Action fires before loading chat from session.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_retrieval_empty #
do_action( 'wyregraf_retrieval_empty', string $query, int $chat_post_id, string $reason, float|null $best_score )Fires when a retrieval query matched no usable context.
Fired before the history fallback, so knowledge-base gaps are recorded even when the LLM can still answer from chat history.
$query(string) — The visitor’s query text.$chat_post_id(int) — The chat group post id.$reason(string) — Why nothing matched: no_results | below_threshold.$best_score(float|null) — The best raw similarity seen, when available.
Since TBD · Source: Wyregraf/src/Vector_Stores/Simple_MySQL/Vector_Store.php
Filters (236) #
'pngx_wyregraf_llm_model_object_for_' . $location'pngx_wyregraf_taxonomy_args_' . $this->taxonomyartifex_license_store_urlfilter_pngx_wyregraf_optionspngx_embedding_label_pluralpngx_embedding_label_plural_lowercasepngx_embedding_label_singularpngx_embedding_label_singular_lowercasepngx_not_php_version_namespngx_taxonomy_label_pluralpngx_taxonomy_label_plural_lowercasepngx_taxonomy_label_singularpngx_taxonomy_label_singular_lowercasepngx_wyregraf_accuracy_llm_query_planpngx_wyregraf_admin_asset_screenspngx_wyregraf_anchor_regexpngx_wyregraf_anthropic_llm_models_pricingpngx_wyregraf_anthropic_modelspngx_wyregraf_anthropic_prompt_cache_contextpngx_wyregraf_anthropic_prompt_cache_enabledpngx_wyregraf_auto_reindex_servable_statusespngx_wyregraf_blank_lines_regexpngx_wyregraf_chat_filter_namespacespngx_wyregraf_chat_show_error_detailspngx_wyregraf_chat_streaming_enabledpngx_wyregraf_chat_system_prompt_textpngx_wyregraf_chat_type_chat_llm_model_objectpngx_wyregraf_chat_type_chat_responsepngx_wyregraf_chat_type_retrieval_embeddings_model_objectpngx_wyregraf_chat_type_retrieval_llm_model_objectpngx_wyregraf_chat_vector_store_{$vectordb}_objectpngx_wyregraf_chats_chat_themespngx_wyregraf_chats_chat_typespngx_wyregraf_chats_meta_fieldspngx_wyregraf_chats_options_field_placement_keypngx_wyregraf_chats_options_fieldspngx_wyregraf_citation_capable_providerspngx_wyregraf_content_loader_metadatapngx_wyregraf_crypto_key_materialpngx_wyregraf_default_{$service_id}_profile_selected_servicepngx_wyregraf_default_chat_typepngx_wyregraf_default_promptspngx_wyregraf_embedding_markdown_links_removal_regexpngx_wyregraf_embeddings_{$service}_model_object{$type}pngx_wyregraf_embeddings_admin_ajax_capabilitypngx_wyregraf_embeddings_ajax_query_argspngx_wyregraf_embeddings_max_attemptspngx_wyregraf_embeddings_meta_fieldspngx_wyregraf_embeddings_meta_tabspngx_wyregraf_embeddings_model_objectpngx_wyregraf_embeddings_options_field_placement_keypngx_wyregraf_embeddings_options_fieldspngx_wyregraf_embeddings_panel_fieldspngx_wyregraf_embeddings_profile_openai_panel_fields_placement_keypngx_wyregraf_embeddings_queue_countpngx_wyregraf_embeddings_removed_post_typespngx_wyregraf_embeddings_scores_limitpngx_wyregraf_embeddings_slugpngx_wyregraf_embeddings_source_{$source_type}pngx_wyregraf_embeddings_source_all_vector_store_index_creator_{$vectordb}pngx_wyregraf_embeddings_source_embeddings_typepngx_wyregraf_enrichment_batch_sizepngx_wyregraf_enrichment_context_budgetpngx_wyregraf_enrichment_token_countpngx_wyregraf_enrichment_versionpngx_wyregraf_escape_anchor_in_markdown_regexpngx_wyregraf_escape_anchor_regexpngx_wyregraf_followup_questions_limitpngx_wyregraf_footer_regexpngx_wyregraf_form_regexpngx_wyregraf_fulltext_min_token_sizepngx_wyregraf_hamming_strategypngx_wyregraf_hash_anchor_regexpngx_wyregraf_http_verify_sslpngx_wyregraf_internal_loader_contentpngx_wyregraf_internal_loader_content_convertedpngx_wyregraf_internal_loader_filtered_content_convertedpngx_wyregraf_label_pluralpngx_wyregraf_label_plural_lowercasepngx_wyregraf_label_singularpngx_wyregraf_label_singular_lowercasepngx_wyregraf_last_access_servicepngx_wyregraf_lever_max_attemptspngx_wyregraf_lexical_depthpngx_wyregraf_llm_{$service}_model_object{$type}pngx_wyregraf_llm_admin_ajax_capabilitypngx_wyregraf_llm_model_objectpngx_wyregraf_llm_options_field_placement_keypngx_wyregraf_llm_options_fieldspngx_wyregraf_llm_panel_fieldspngx_wyregraf_llm_profile_anthropic_panel_fields_placement_keypngx_wyregraf_llm_profile_openai_panel_fields_placement_keypngx_wyregraf_managerpngx_wyregraf_max_attemptspngx_wyregraf_max_document_bytespngx_wyregraf_message_history_limitpngx_wyregraf_meta_tabspngx_wyregraf_models_pricingpngx_wyregraf_nav_regexpngx_wyregraf_normalized_questionspngx_wyregraf_openai_embeddings_modelspngx_wyregraf_openai_embeddings_models_pricingpngx_wyregraf_openai_llm_models_pricingpngx_wyregraf_openai_modelspngx_wyregraf_option_sectionspngx_wyregraf_picture_regexpngx_wyregraf_planner_candidate_depthpngx_wyregraf_planner_subquery_limitpngx_wyregraf_post_embeddings_meta_fieldspngx_wyregraf_post_loader_contentpngx_wyregraf_post_loader_content_convertedpngx_wyregraf_post_loader_content_converted_type_pngx_wyregraf_post_loader_content_converted_type_{$post_type}pngx_wyregraf_post_loader_content_type_{$post_type}pngx_wyregraf_pre_embed_documentspngx_wyregraf_pro_agent_convert_html_entities_encodingpngx_wyregraf_pro_agent_convert_html_entities_flagspngx_wyregraf_pro_agent_label_pluralpngx_wyregraf_pro_agent_label_plural_lowercasepngx_wyregraf_pro_agent_label_singularpngx_wyregraf_pro_agent_label_singular_lowercasepngx_wyregraf_pro_agent_meta_tabspngx_wyregraf_pro_agents_ajax_query_argspngx_wyregraf_pro_agents_meta_fieldspngx_wyregraf_pro_agents_slugpngx_wyregraf_pro_chat_endpointspngx_wyregraf_pro_chat_session_handlerpngx_wyregraf_pro_chat_show_error_detailspngx_wyregraf_pro_chats_meta_fieldspngx_wyregraf_pro_code_embeddings_meta_fieldspngx_wyregraf_pro_code_embeddings_zip_max_entriespngx_wyregraf_pro_code_embeddings_zip_max_total_bytespngx_wyregraf_pro_code_loader_contentpngx_wyregraf_pro_get_code_excluded_dirspngx_wyregraf_pro_get_code_excluded_file_typespngx_wyregraf_pro_get_code_excluded_filespngx_wyregraf_pro_get_code_zip_max_file_sizepngx_wyregraf_pro_get_code_zip_minified_assets_regexpngx_wyregraf_pro_get_code_zip_minimum_file_sizepngx_wyregraf_pro_network_label_pluralpngx_wyregraf_pro_network_label_plural_lowercasepngx_wyregraf_pro_network_label_singularpngx_wyregraf_pro_network_label_singular_lowercasepngx_wyregraf_pro_networks_ajax_query_argspngx_wyregraf_pro_networks_meta_fieldspngx_wyregraf_pro_networks_meta_tabspngx_wyregraf_pro_networks_slugpngx_wyregraf_pro_pdf_smalot_embeddings_meta_fieldspngx_wyregraf_pro_pdf_smalot_loader_contentpngx_wyregraf_pro_set_code_embeddings_zip_excluded_directoriespngx_wyregraf_pro_set_code_embeddings_zip_excluded_filespngx_wyregraf_pro_set_code_embeddings_zip_excluded_filetypespngx_wyregraf_pro_set_code_embeddings_zip_excluded_full_pathspngx_wyregraf_pro_set_code_embeddings_zip_max_file_sizepngx_wyregraf_pro_set_code_embeddings_zip_minimum_file_sizepngx_wyregraf_pro_tool_' . Identifier::TOOL_ID . '_meta_fieldspngx_wyregraf_pro_url_scrape_embeddings_meta_fieldspngx_wyregraf_pro_url_scrape_loader_contentpngx_wyregraf_pro_url_scrape_loader_filtered_contentpngx_wyregraf_pro_use_evaluation_agentpngx_wyregraf_pro_use_fallback_agentpngx_wyregraf_prompt_default_chat_promptpngx_wyregraf_prompt_default_questions_promptpngx_wyregraf_prompt_default_retrieval_promptpngx_wyregraf_prompt_default_summary_promptpngx_wyregraf_prompt_default_system_promptpngx_wyregraf_prompt_label_pluralpngx_wyregraf_prompt_label_plural_lowercasepngx_wyregraf_prompt_label_singularpngx_wyregraf_prompt_label_singular_lowercasepngx_wyregraf_prompt_slugpngx_wyregraf_prompts_ajax_query_argspngx_wyregraf_query_processor_max_attemptspngx_wyregraf_question_queue_countpngx_wyregraf_queue_task_time_budgetpngx_wyregraf_quota_policypngx_wyregraf_rate_limitpngx_wyregraf_rate_limit_ippngx_wyregraf_regenerate_supported_answerpngx_wyregraf_rerank_candidatespngx_wyregraf_reranker_candidate_depthpngx_wyregraf_reranker_providerpngx_wyregraf_retrieval_backfill_batch_sizepngx_wyregraf_retrieval_document_overviewpngx_wyregraf_retrieval_enrichment_outputpngx_wyregraf_retrieval_namespacepngx_wyregraf_rrf_constantpngx_wyregraf_script_regexpngx_wyregraf_search_cache_ttlpngx_wyregraf_search_candidate_limitpngx_wyregraf_sentence_rows_retrievablepngx_wyregraf_setup_default_propertiespngx_wyregraf_simple_mysql_database_install_capabilities_checkpngx_wyregraf_simple_mysql_enabledpngx_wyregraf_slugpngx_wyregraf_source_{$embedding_data['source_type']}_model_objectpngx_wyregraf_source_{$source_type}_model_objectpngx_wyregraf_source_{$this->source_id}_model_objectpngx_wyregraf_source_internal_model_objectpngx_wyregraf_source_post_model_objectpngx_wyregraf_span_regexpngx_wyregraf_starter_questions_cache_ttlpngx_wyregraf_strip_html_anchors_in_citations_regexpngx_wyregraf_style_regexpngx_wyregraf_summary_queue_countpngx_wyregraf_supported_system_versionpngx_wyregraf_svg_regexpngx_wyregraf_taxonomy_slugpngx_wyregraf_url_guard_allowedpngx_wyregraf_url_guard_portspngx_wyregraf_url_guard_resolverpngx_wyregraf_usage_costpngx_wyregraf_usage_identitypngx_wyregraf_vector_store_thresholdpngx_wyregraf_verify_answer_supportpngx_wyregraf_voyage_request_timeoutwp_pngx_session_cookie_namewyregraf_admin_menu_itmeswyregraf_analytics_admin_capabilitywyregraf_analytics_retention_batch_sizewyregraf_analytics_tileswyregraf_insights_admin_capabilitywyregraf_insights_retention_batch_sizewyregraf_pro_chat_group_get_chat_group_idwyregraf_pro_chat_group_hashwyregraf_pro_chat_group_persistent_chats_enabledwyregraf_pro_get_chat_group_from_sessionwyregraf_rest_openapi_documentationwyregraf_rest_urlwyregraf_rest_url_prefixwyregraf_rest_use_builtinwyregraf_setup_admin_capabilitywyregraf_transcripts_admin_capabilitywyregraf_transcripts_chat_group_userswyregraf_transcripts_message_limitwyregraf_transcripts_retention_batch_size
'pngx_wyregraf_llm_model_object_for_' . $location #
apply_filters( ''pngx_wyregraf_llm_model_object_for_' . $location', \Wyregraf\Libraries\Kambo\Langchain\LLM $llm_model, \Profiles $embeddings_profile )Filter the chat llm model object.
$llm_model(\Wyregraf\Libraries\Kambo\Langchain\LLM) — An instance of the llm model object, or null when the profile failed to load.$embeddings_profile(\Profiles) — An instance of the Embeddings profiles.
Since 0.5.0 · Source: Wyregraf/src/LLM/Traits/Setup.php
'pngx_wyregraf_taxonomy_args_' . $this->taxonomy #
apply_filters( ''pngx_wyregraf_taxonomy_args_' . $this->taxonomy', (string|mixed)[] $args )Filter the arguments used to register the taxonomy.
$args((string|mixed)[]) — Array of arguments for registering a taxonomy.
Since 0.1.0 · Source: Wyregraf/src/Taxonomy/Namespaces.php
artifex_license_store_url #
apply_filters( 'artifex_license_store_url', string $url, string $slug )Filters the EDD licensing endpoint.
$url(string) — Store URL.$slug(string) — Plugin slug.
Source: Wyregraf_Pro/src/Admin/SDK_License.php
filter_pngx_wyregraf_options #
apply_filters( 'filter_pngx_wyregraf_options', (string|mixed)[] $, \Options $ )Filter the options fields from Wyregraf.
$((string|mixed)[]) — An array of option fields to display.$(\Options) — The instance of the options handler.
Since 0.1.0 · Source: Wyregraf/src/Admin/Options.php
pngx_embedding_label_plural #
apply_filters( 'pngx_embedding_label_plural', string $label )Filters the plural Embedding post type label.
$label(string) — The plural label. Default ‘Embeddings’.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Post_Type.php
pngx_embedding_label_plural_lowercase #
apply_filters( 'pngx_embedding_label_plural_lowercase', string $label )Filters the lowercase plural Embedding post type label.
$label(string) — The lowercase plural label. Default ’embeddings’.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Post_Type.php
pngx_embedding_label_singular #
apply_filters( 'pngx_embedding_label_singular', string $label )Filters the singular Embedding post type label.
$label(string) — The singular label. Default ‘Embedding’.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Post_Type.php
pngx_embedding_label_singular_lowercase #
apply_filters( 'pngx_embedding_label_singular_lowercase', string $label )Filters the lowercase singular Embedding post type label.
$label(string) — The lowercase singular label. Default ’embedding’.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Post_Type.php
pngx_not_php_version_names #
apply_filters( 'pngx_not_php_version_names', array $names )Allow us to include more plugins without increasing the number of notices.
$names(array) — Name of the plugins that are not compatible.
Since 0.1.0 · Source: Wyregraf/functions/php-min-version.php
pngx_taxonomy_label_plural #
apply_filters( 'pngx_taxonomy_label_plural', string $label )Filters the plural Namespace taxonomy label.
$label(string) — The plural label. Default ‘Namespaces’.
Since 0.1.0 · Source: Wyregraf/src/Taxonomy/Namespaces.php
pngx_taxonomy_label_plural_lowercase #
apply_filters( 'pngx_taxonomy_label_plural_lowercase', string $label )Filters the lowercase plural Namespace taxonomy label.
$label(string) — The lowercase plural label. Default ‘namespaces’.
Since 0.1.0 · Source: Wyregraf/src/Taxonomy/Namespaces.php
pngx_taxonomy_label_singular #
apply_filters( 'pngx_taxonomy_label_singular', string $label )Filters the singular Namespace taxonomy label.
$label(string) — The singular label. Default ‘Namespace’.
Since 0.1.0 · Source: Wyregraf/src/Taxonomy/Namespaces.php
pngx_taxonomy_label_singular_lowercase #
apply_filters( 'pngx_taxonomy_label_singular_lowercase', string $label )Filters the lowercase singular Namespace taxonomy label.
$label(string) — The lowercase singular label. Default ‘namespace’.
Since 0.1.0 · Source: Wyregraf/src/Taxonomy/Namespaces.php
pngx_wyregraf_accuracy_llm_query_plan #
apply_filters( 'pngx_wyregraf_accuracy_llm_query_plan' )Provider-neutral query planner seam. Implementations receive untrusted user text and must return JSON or an array matching validate().
Source: Wyregraf/src/Retrieval/Query_Planner.php
pngx_wyregraf_admin_asset_screens #
apply_filters( 'pngx_wyregraf_admin_asset_screens', string[] $screens )Filters the admin screens that receive Wyregraf’s admin CSS/JS.
$screens(string[]) — List of screen IDs.
Since 0.5.1 · Source: Wyregraf/src/Assets/Provider.php
pngx_wyregraf_anchor_regex #
apply_filters( 'pngx_wyregraf_anchor_regex', string $anchor_regex )Filter the regex pattern for replacing anchor tags with their href values.
$anchor_regex(string) — The regex pattern for replacing anchor tags with their href values.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_anthropic_llm_models_pricing #
apply_filters( 'pngx_wyregraf_anthropic_llm_models_pricing', (string|mixed)[] $anthropic_models )Filter the Anthropic models for pricing.
$anthropic_models((string|mixed)[]) — The array of Anthropic models for pricing.
Since 0.5.0 · Source: Wyregraf/src/Services/Anthropic/LLM_Api.php
pngx_wyregraf_anthropic_models #
apply_filters( 'pngx_wyregraf_anthropic_models', (string|mixed)[] $anthropic_models )Filter the Anthropic models.
$anthropic_models((string|mixed)[]) — The array of Anthropic models.
Since 0.5.0 · Source: Wyregraf/src/Services/Anthropic/LLM_Api.php
pngx_wyregraf_anthropic_prompt_cache_context #
apply_filters( 'pngx_wyregraf_anthropic_prompt_cache_context', string $context, \Document $document, mixed $model )Filters the shared document context passed to every chunk enrichment request.
The context is identical for all chunks of a document so a provider with prompt caching can reuse it.
$context(string) — The bounded document context.$document(\Document) — The source document.$model(mixed) — The LLM model object.
Source: Wyregraf/src/Process/Retrieval_Enrichment_Queue.php
pngx_wyregraf_anthropic_prompt_cache_enabled #
apply_filters( 'pngx_wyregraf_anthropic_prompt_cache_enabled', bool $enabled, object $document, string $model_name )Filters whether an Anthropic document block is marked for prompt caching.
Anthropic allows at most four cache breakpoints per request, so the filter only runs while that cap has not been reached.
$enabled(bool) — Whether to add cache_control to the document block. Default true.$document(object) — The retrieved Document object.$model_name(string) — The Anthropic model name.
Source: Wyregraf/src/Libraries/Kambo/Langchain/LLMs/BaseAnthropic.php
pngx_wyregraf_auto_reindex_servable_statuses #
apply_filters( 'pngx_wyregraf_auto_reindex_servable_statuses', string[] $statuses )Filter the post statuses eligible for auto re-indexing. Anything else is dropped from the index so unpublished content is not served.
$statuses(string[]) — The servable statuses. Default [‘publish’].
Since 0.7.0 · Source: Wyregraf/src/Sources/Auto_Reindex/Provider.php
pngx_wyregraf_blank_lines_regex #
apply_filters( 'pngx_wyregraf_blank_lines_regex', string $blank_lines_regex )Filter the regex pattern for removing blank lines.
$blank_lines_regex(string) — The regex pattern for removing blank lines.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_chat_filter_namespaces #
apply_filters( 'pngx_wyregraf_chat_filter_namespaces', (string|mixed)[] $term_ids, int $wyregraf_atts, (string|mixed)[] $wyregraf_atts )Filter the namespace terms for chat filters.
$term_ids((string|mixed)[]) — An array of term ids and names.$wyregraf_atts(int) — [‘vectorid’] The chat post id.$wyregraf_atts((string|mixed)[]) — The chat shortcode attributes.
Since 0.3.0 · Source: Wyregraf/src/Chats/Shortcode/Vectors.php
pngx_wyregraf_chat_show_error_details #
apply_filters( 'pngx_wyregraf_chat_show_error_details', bool $can_see_details, \Exception $e )Filters whether the current user may see the provider’s chat error.
$can_see_details(bool) — Whether to show the error detail. Default: can manage options.$e(\Exception) — The chat pipeline exception.
Since TBD · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_chat_streaming_enabled #
apply_filters( 'pngx_wyregraf_chat_streaming_enabled', bool $enabled, int $chat_post_id )Filters whether streamed chat responses are enabled (host kill-switch).
$enabled(bool) — Whether streaming is enabled.$chat_post_id(int) — The chat post id.
Since TBD · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_chat_system_prompt_text #
apply_filters( 'pngx_wyregraf_chat_system_prompt_text', string $system_prompt, int $chat_post_id, string $prompt_key )Filter the assembled per-chat system prompt text before it is templated.
$system_prompt(string) — The assembled system prompt text.$chat_post_id(int) — The chat post id.$prompt_key(string) — The meta key used to resolve the base prompt post.
Since TBD · Source: Wyregraf/src/Prompts/Traits/Prompt_Utilities.php
pngx_wyregraf_chat_type_chat_llm_model_object #
apply_filters( 'pngx_wyregraf_chat_type_chat_llm_model_object', \Wyregraf\Libraries\Kambo\Langchain\LLM $llm_model, \Profiles $embeddings_profile )Filter the chat llm model object.
$llm_model(\Wyregraf\Libraries\Kambo\Langchain\LLM) — An instance of the llm model object.$embeddings_profile(\Profiles) — An instance of the Embeddings profiles.
Since 0.1.0 · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_chat_type_chat_response #
apply_filters( 'pngx_wyregraf_chat_type_chat_response', (string|mixed)[] $response, \ChatPromptTemplate $chat_prompts, \LLM_Profiles $llm_profile, \BaseLLM $llm_model, int $chat_post_id, (string|mixed)[] $chat_history )Filter the chat client response
$response((string|mixed)[]) — The response for the LLM chat API.$chat_prompts(\ChatPromptTemplate) — An instance of the Chat Prompt Template.$llm_profile(\LLM_Profiles) — An instance of the LLM Service Profiles.$llm_model(\BaseLLM) — An instance of a LLM class.$chat_post_id(int) — The chat post id.$chat_history((string|mixed)[]) — An array of the chat history.
Since 0.1.0 · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_chat_type_retrieval_embeddings_model_object #
apply_filters( 'pngx_wyregraf_chat_type_retrieval_embeddings_model_object', \Wyregraf\Libraries\Kambo\Langchain\Embeddings $embeddings_model, \Profiles $embeddings_profile )Filter the chat embeddings model object.
$embeddings_model(\Wyregraf\Libraries\Kambo\Langchain\Embeddings) — An instance of the embeddings model object.$embeddings_profile(\Profiles) — An instance of the Embeddings profiles.
Since 0.1.0 · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_chat_type_retrieval_llm_model_object #
apply_filters( 'pngx_wyregraf_chat_type_retrieval_llm_model_object', \Wyregraf\Libraries\Kambo\Langchain\LLM $llm_model, \Profiles $embeddings_profile )Filter the chat llm model object.
$llm_model(\Wyregraf\Libraries\Kambo\Langchain\LLM) — An instance of the llm model object.$embeddings_profile(\Profiles) — An instance of the Embeddings profiles.
Since 0.1.0 · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_chat_vector_store_{$vectordb}_object #
apply_filters( 'pngx_wyregraf_chat_vector_store_{$vectordb}_object', null $vector_store, \Profiles $embeddings_profile, \Wyregraf\Libraries\Kambo\Langchain\Embeddings $embeddings_model, (string|mixed)[] $vector_options )Filter the chat vector store object.
$vector_store(null) — An instance of the vector store object.$embeddings_profile(\Profiles) — An instance of the Embeddings profiles.$embeddings_model(\Wyregraf\Libraries\Kambo\Langchain\Embeddings) — An instance of the embeddings model object.$vector_options((string|mixed)[]) — An array of options to use with the vector store.
Since 0.1.0 · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_chats_chat_themes #
apply_filters( 'pngx_wyregraf_chats_chat_themes', array $chat_themes )Filter the chat themes available for chats.
$chat_themes(array) — The chat themes.
Since 1.0.0 · Source: Wyregraf/src/Chats/Traits/Utilities.php
pngx_wyregraf_chats_chat_types #
apply_filters( 'pngx_wyregraf_chats_chat_types', array $chat_types )Filter the chat types available for chats.
$chat_types(array) — The chat types.
Since 1.0.0 · Source: Wyregraf/src/Chats/Traits/Utilities.php
pngx_wyregraf_chats_meta_fields #
apply_filters( 'pngx_wyregraf_chats_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the meta fields for the post type.
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.1.0 · Source: Wyregraf/src/Chats/Meta_Fields.php
pngx_wyregraf_chats_options_field_placement_key #
apply_filters( 'pngx_wyregraf_chats_options_field_placement_key', string $, \Options $this )Filters the array key to place the API integration settings.
$(string) — The default array key to place the API integration fields.$this(\Options) — This Settings instance.
Since 0.1.0 · Source: Wyregraf/src/Chats/Options.php
pngx_wyregraf_chats_options_fields #
apply_filters( 'pngx_wyregraf_chats_options_fields', array<string,array> $, \Options $options )Filters the options shown to the user in the Options page.
$(array<string,array>) — A map of the API fields that will be printed on the page.$options(\Options) — An Options instance.
Since 0.1.0 · Source: Wyregraf/src/Chats/Options.php
pngx_wyregraf_citation_capable_providers #
apply_filters( 'pngx_wyregraf_citation_capable_providers', string[] $providers )Providers whose answers can carry enforceable citations.
$providers(string[]) — Provider IDs.
Source: Wyregraf/src/Grounding/Citation_Integrity.php
pngx_wyregraf_content_loader_metadata #
apply_filters( 'pngx_wyregraf_content_loader_metadata', array $merged_metadata )Filters the combined metadata array.
$merged_metadata(array) — The combined metadata.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_crypto_key_material #
apply_filters( 'pngx_wyregraf_crypto_key_material', string $material )Filters the raw key material used to derive the credential encryption key.
Advanced use only (e.g. a dedicated key constant, or tests simulating salt rotation). Changing this on a live site makes existing ciphertexts unreadable.
$material(string) — The raw key material (AUTH_KEY . AUTH_SALT by default).
Since TBD · Source: Wyregraf/src/Security/Crypto.php
pngx_wyregraf_default_{$service_id}_profile_selected_service #
apply_filters( 'pngx_wyregraf_default_{$service_id}_profile_selected_service', string $selected_service, string $service_id )Filter the default selected service for a profile.
$selected_service(string) — The default selected service.$service_id(string) — The service id.
Since 0.1.0 · Source: Wyregraf/admin-views/profiles/list/profile-new.php
pngx_wyregraf_default_chat_type #
apply_filters( 'pngx_wyregraf_default_chat_type', string $default_chat_type )Filter the default chat type.
$default_chat_type(string) — The default chat type.
Since 0.5.0 · Source: Wyregraf/src/Chats/Meta_Fields.php
pngx_wyregraf_default_prompts #
apply_filters( 'pngx_wyregraf_default_prompts', (string|mixed)[] $post_data )Filter the default prompts data.
This filter allows third-party code to modify the default prompts data.
$post_data((string|mixed)[]) — Default prompts data.
Since 0.1.0 · Source: Wyregraf/src/Prompts/Post_Type.php
pngx_wyregraf_embedding_markdown_links_removal_regex #
apply_filters( 'pngx_wyregraf_embedding_markdown_links_removal_regex', string $blank_lines_regex )Filter the regex pattern for removing markdown links before creating embeddings.
$blank_lines_regex(string) — The regex pattern for markdown removing links.
Since 0.1.0 · Source: Wyregraf/src/Vector_Stores/Traits/Vector_Store_Utilities.php
pngx_wyregraf_embeddings_{$service}_model_object{$type} #
apply_filters( 'pngx_wyregraf_embeddings_{$service}_model_object{$type}', string $service, (string|mixed)[] $embeddings_properties )Filter the embeddings model by service.
$service(string) — The id of the service to provide the embeddings.$embeddings_properties((string|mixed)[]) — An array of the embeddings properties such as API key, chunk size, etc.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Profiles.php
pngx_wyregraf_embeddings_admin_ajax_capability #
apply_filters( 'pngx_wyregraf_embeddings_admin_ajax_capability', string $ajax_capability )Allows filtering of the capability required to use the integration ajax features.
$ajax_capability(string) — The capability required to use the ajax features, default manage_options.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Provider.php
pngx_wyregraf_embeddings_ajax_query_args #
apply_filters( 'pngx_wyregraf_embeddings_ajax_query_args', (string|mixed)[] $args, string $selected, (string|mixed)[] $search, int $page )Filter the query arguments before running WP_Query.
$args((string|mixed)[]) — The query arguments for WP_Query.$selected(string) — The selected value.$search((string|mixed)[]) — The search parameters.$page(int) — The current page number.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Ajax.php
pngx_wyregraf_embeddings_max_attempts #
apply_filters( 'pngx_wyregraf_embeddings_max_attempts', int $attempts )Filter the maximum embedding attempts before a job is dead-lettered.
$attempts(int) — The attempt ceiling. Default 3.
Since 0.7.0 · Source: Wyregraf/src/Process/Traits/Retryable.php
pngx_wyregraf_embeddings_meta_fields #
apply_filters( 'pngx_wyregraf_embeddings_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the meta fields for the post type.
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Meta_Fields.php
pngx_wyregraf_embeddings_meta_tabs #
apply_filters( 'pngx_wyregraf_embeddings_meta_tabs', (string)[] $tabs )Filter the Wyregraf Meta Tab Header
$tabs((string)[]) — an array of tab headings.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Meta.php
pngx_wyregraf_embeddings_model_object #
apply_filters( 'pngx_wyregraf_embeddings_model_object', \Wyregraf\Libraries\Kambo\Langchain\Embeddings $embeddings, \Profiles $embeddings_profiles )Filter the embeddings model object.
$embeddings(\Wyregraf\Libraries\Kambo\Langchain\Embeddings) — An instance of the embeddings model object.$embeddings_profiles(\Profiles) — An instance of the Embeddings profiles.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Profiles.php
pngx_wyregraf_embeddings_options_field_placement_key #
apply_filters( 'pngx_wyregraf_embeddings_options_field_placement_key', string $, \Options $this )Filters the array key to place the service profile fields.
$(string) — The default array key to place service profile fields.$this(\Options) — This Settings instance.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Options.php
pngx_wyregraf_embeddings_options_fields #
apply_filters( 'pngx_wyregraf_embeddings_options_fields', array $embedding_post_types, array $all_post_types )Filter the custom post types that can be used for embedding.
$embedding_post_types(array) — The modified custom post types array.$all_post_types(array) — The original custom post types array.
Since 1.0.0 · Source: Wyregraf/src/Embeddings/Traits/Utilities.php
pngx_wyregraf_embeddings_panel_fields #
apply_filters( 'pngx_wyregraf_embeddings_panel_fields', (string|mixed)[] $panel_fields, (string|mixed)[] $profile_data )Filter the panel fields for the embeddings profile.
$panel_fields((string|mixed)[]) — The array of panel fields.$profile_data((string|mixed)[]) — The profile data.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Profiles.php
pngx_wyregraf_embeddings_profile_openai_panel_fields_placement_key #
apply_filters( 'pngx_wyregraf_embeddings_profile_openai_panel_fields_placement_key', string $, \Embeddings_Api $this )Filters the array key to place the OpenAI embeddings panel fields.
$(string) — The default array key to place the OpenAI embeddings panel fields.$this(\Embeddings_Api) — This Api instance.
Since 0.1.0 · Source: Wyregraf/src/Services/OpenAI/Embeddings_Api.php
pngx_wyregraf_embeddings_queue_count #
apply_filters( 'pngx_wyregraf_embeddings_queue_count', int $batch_size )Filter the Wyregraf batch size for creating embeddings queue.
$batch_size(int) — The batch size for creating embeddings queue, default 10.
Since 0.4.0 · Source: Wyregraf/src/Libraries/Kambo/Langchain/Indexes/VectorstoreIndexCreator.php
pngx_wyregraf_embeddings_removed_post_types #
apply_filters( 'pngx_wyregraf_embeddings_removed_post_types', array $removed_post_types )Filter the post types that are removed from the list of post types that can be used for embedding.
$removed_post_types(array) — An array of post types to be removed.
Since 1.0.0 · Source: Wyregraf/src/Embeddings/Traits/Utilities.php
pngx_wyregraf_embeddings_scores_limit #
apply_filters( 'pngx_wyregraf_embeddings_scores_limit', int $limit, \Abstract_Collection $this )Filters the limit for the number of scores to retrieve.
$limit(int) — The number of scores to retrieve. Default 50.$this(\Abstract_Collection) — An instance of the collection class
Since 0.1.0 · Source: Wyregraf/src/Vector_Stores/Abstract_Collection.php
pngx_wyregraf_embeddings_slug #
apply_filters( 'pngx_wyregraf_embeddings_slug', string $slug )Provides an opportunity to modify the Embeddings slug.
$slug(string) — The sanitized slug from the options page.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Post_Type.php
pngx_wyregraf_embeddings_source_{$source_type} #
apply_filters( 'pngx_wyregraf_embeddings_source_{$source_type}', (string|mixed)[] $data )Filters the embeddings creation to allow multiple embedding services.
$source_type is the source type of the content to create embeddings.
$data((string|mixed)[]) — An array of data to create embeddings.
Since 0.1.0 · Source: Wyregraf/src/Embeddings/Profiles.php
pngx_wyregraf_embeddings_source_all_vector_store_index_creator_{$vectordb} #
apply_filters( 'pngx_wyregraf_embeddings_source_all_vector_store_index_creator_{$vectordb}', \VectorStoreIndexCreator $vector_store_index_creator, \Profiles $embeddings_profiles, \RecursiveCodeTextSplitter $textSplitter )Filter the chat embeddings model object.
$vector_store_index_creator(\VectorStoreIndexCreator) — An instance of the vector store index creator.$embeddings_profiles(\Profiles) — An instance of the Embeddings profiles.$textSplitter(\RecursiveCodeTextSplitter) — An instance of the RecursiveCharacterTextSplitter
Since 0.4.0 · Source: Wyregraf/src/Process/Embeddings_Queue.php
pngx_wyregraf_embeddings_source_embeddings_type #
apply_filters( 'pngx_wyregraf_embeddings_source_embeddings_type', string $type, string $source_id, string $source_name )Filter the source embeddings type.
$type(string) — The embeddings type. ( standard, summary, questions )$source_id(string) — The source id$source_name(string) — The source name.
Since 0.5.0 · Source: Wyregraf/src/Sources/Abstract_Controller.php
pngx_wyregraf_enrichment_batch_size #
apply_filters( 'pngx_wyregraf_enrichment_batch_size', int $batch_size )Filters the number of documents per retrieval enrichment queue task.
Each document costs one or more LLM round-trips, so the batch is small by default.
$batch_size(int) — The documents per enrichment task. Default 2.
Source: Wyregraf/src/Libraries/Kambo/Langchain/Indexes/VectorstoreIndexCreator.php
pngx_wyregraf_enrichment_context_budget #
apply_filters( 'pngx_wyregraf_enrichment_context_budget', int $budget, int $embeddings_post_id )Filters the token budget for the document context sent with each enrichment request.
A document above the budget is replaced by a generated overview. Values below 1000 are raised to 1000.
$budget(int) — The context token budget. Default 24000.$embeddings_post_id(int) — The embeddings (source) post ID.
Source: Wyregraf/src/Process/Retrieval_Enrichment_Queue.php
pngx_wyregraf_enrichment_token_count #
apply_filters( 'pngx_wyregraf_enrichment_token_count', int $estimate, string $text, mixed $model )Filters the estimated token count of a text when the model exposes no tokenizer.
$estimate(int) — The estimated token count, one token per four characters.$text(string) — The text being measured.$model(mixed) — The LLM model object.
Source: Wyregraf/src/Process/Retrieval_Enrichment_Queue.php
pngx_wyregraf_enrichment_version #
apply_filters( 'pngx_wyregraf_enrichment_version', string $version )Filters the enrichment pipeline version mixed into the index-settings fingerprint.
Changing the value changes every source’s fingerprint, which flags already indexed sources as needing a reindex.
$version(string) — The enrichment version. Default Transformer::VERSION.
Source: Wyregraf/src/Embeddings/Index_Settings.php
pngx_wyregraf_escape_anchor_in_markdown_regex #
apply_filters( 'pngx_wyregraf_escape_anchor_in_markdown_regex', string $anchor_regex )Filter the regex pattern for escaping anchor tags in markdown.
$anchor_regex(string) — The regex pattern for escaping anchor tags.
Since 0.1.0 · Source: Wyregraf/src/Prompts/Traits/Prompt_Utilities.php
pngx_wyregraf_escape_anchor_regex #
apply_filters( 'pngx_wyregraf_escape_anchor_regex', string $anchor_regex )Filter the regex pattern for securing anchor tags.
$anchor_regex(string) — The regex pattern for securing anchor tags.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_followup_questions_limit #
apply_filters( 'pngx_wyregraf_followup_questions_limit', int $limit, int $chat_post_id )Filters the maximum number of follow-up questions shown under an answer.
$limit(int) — The limit. Default 3.$chat_post_id(int) — The chat group post ID.
Since TBD · Source: Wyregraf/src/Chats/Questions.php
pngx_wyregraf_footer_regex #
apply_filters( 'pngx_wyregraf_footer_regex', string $footer_regex )Filter the regex pattern for footer tags removal.
$footer_regex(string) — The regex pattern for footer tags removal.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_form_regex #
apply_filters( 'pngx_wyregraf_form_regex', string $form_regex )Filter the regex pattern for form tags removal.
$form_regex(string) — The regex pattern for form tags removal.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_fulltext_min_token_size #
apply_filters( 'pngx_wyregraf_fulltext_min_token_size', int $min_token_size )Filters the minimum token length used when building a FULLTEXT boolean-mode source search.
Shorter tokens are dropped from the search string. The value should match the database’s innodb_ft_min_token_size (or ft_min_word_len) setting.
$min_token_size(int) — The minimum token length. Default 3.
Source: Wyregraf/src/Database/Handlers/Sources.php
pngx_wyregraf_hamming_strategy #
apply_filters( 'pngx_wyregraf_hamming_strategy', string $strategy )Filters the Hamming prefilter strategy.
$strategy(string) — ‘bit_count’ (inline expression) or ‘udf’ (HAMMING() routine).
Since TBD · Source: Wyregraf/src/Vector_Stores/Simple_MySQL/Collection.php
pngx_wyregraf_hash_anchor_regex #
apply_filters( 'pngx_wyregraf_hash_anchor_regex', string $anchor_regex )Filter the regex pattern for removing hash links tags and keeping the text.
$anchor_regex(string) — The regex pattern for removing hash links tags and keeping the text.
Since 0.2.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_http_verify_ssl #
apply_filters( 'pngx_wyregraf_http_verify_ssl', bool $verify, string $url )Filters whether TLS certificates are verified on URL-scrape fetches.
Never tied to WP_DEBUG: local setups with self-signed certificates must opt out explicitly.
$verify(bool) — Whether to verify TLS certificates.$url(string) — The URL being fetched.
Since TBD · Source: Wyregraf_Pro/src/Sources/URL_Scrape/URL_Scrape_Loader.php
pngx_wyregraf_internal_loader_content #
apply_filters( 'pngx_wyregraf_internal_loader_content', string $content, \WP_Post $post )Filter the embedding content to create embeddings with before clean up and markdown conversion.
$content(string) — The content from the post, page, or custom post type to create embeddings.$post(\WP_Post) — The post object.
Since 0.4.0 · Source: Wyregraf/src/Sources/Internal/Internal_Loader.php
pngx_wyregraf_internal_loader_content_converted #
apply_filters( 'pngx_wyregraf_internal_loader_content_converted', string $content, \WP_Post $post )Filter the embedding content by post type after clean up and markdown conversion.
$content(string) — The content from the post, page, or custom post type to create embeddings.$post(\WP_Post) — The post object.
Since 0.4.0 · Source: Wyregraf/src/Sources/Internal/Internal_Loader.php
pngx_wyregraf_internal_loader_filtered_content_converted #
apply_filters( 'pngx_wyregraf_internal_loader_filtered_content_converted', string $document_filtered, string $content )Filter the internal source filtered content to use in previews.
$document_filtered(string) — The content from the post, page, or custom post type to use in previews.$content(string) — The original source.
Since 0.5.0 · Source: Wyregraf/src/Sources/Internal/Internal_Loader.php
pngx_wyregraf_label_plural #
apply_filters( 'pngx_wyregraf_label_plural', string $label )Filters the plural chat label shown in the admin menu and list table.
$label(string) — Plural label. Default ‘Wyregraf’.
Since 0.1.0 · Source: Wyregraf/src/Chats/Post_Type.php
pngx_wyregraf_label_plural_lowercase #
apply_filters( 'pngx_wyregraf_label_plural_lowercase', string $label )Filters the lowercase plural chat label for notices and help text.
$label(string) — Lowercase plural label. Default ‘wyregraf vectors’.
Since 0.1.0 · Source: Wyregraf/src/Chats/Post_Type.php
pngx_wyregraf_label_singular #
apply_filters( 'pngx_wyregraf_label_singular', string $label )Filters the singular label of the Wyregraf Vector (chat) post type.
$label(string) — The singular label. Default ‘Wyregraf Vector’.
Since 0.1.0 · Source: Wyregraf/src/Chats/Post_Type.php
pngx_wyregraf_label_singular_lowercase #
apply_filters( 'pngx_wyregraf_label_singular_lowercase', string $label )Filters the lowercase singular chat label used inside sentences.
$label(string) — Lowercase singular label. Default ‘wyregraf vector’.
Since 0.1.0 · Source: Wyregraf/src/Chats/Post_Type.php
pngx_wyregraf_last_access_service #
apply_filters( 'pngx_wyregraf_last_access_service', string $service )Filters the last access app name.
$service(string) — The service identifier to display in last access, default is none.
Since 0.1.0 · Source: Wyregraf/src/Access_Profiles/Abstract_Access_Profiles.php
pngx_wyregraf_lever_max_attempts #
apply_filters( 'pngx_wyregraf_lever_max_attempts', int $max_attempts )Filter the maximum number of attempts for query processing.
$max_attempts(int) — The default maximum number of attempts.
Since 0.5.0 · Source: Wyregraf_Pro/src/Tools/Types/Lever/Controller.php
pngx_wyregraf_lexical_depth #
apply_filters( 'pngx_wyregraf_lexical_depth', int $depth )Filters how many lexical (FULLTEXT) candidates are fetched for hybrid fusion.
$depth(int) — Number of lexical candidates. Default is the larger of 100 and five times the requested result count.
Source: Wyregraf/src/Vector_Stores/Simple_MySQL/Collection.php
pngx_wyregraf_llm_{$service}_model_object{$type} #
apply_filters( 'pngx_wyregraf_llm_{$service}_model_object{$type}', string $service, (string|mixed)[] $llm_properties )Filter the llm model by service.
$service(string) — The id of the service to provide the llm.$llm_properties((string|mixed)[]) — An array of the llm properties such as API key, model, etc.
Since 0.1.0 · Source: Wyregraf/src/LLM/Profiles.php
pngx_wyregraf_llm_admin_ajax_capability #
apply_filters( 'pngx_wyregraf_llm_admin_ajax_capability', string $ajax_capability )Allows filtering of the capability required to use the integration ajax features.
$ajax_capability(string) — The capability required to use the ajax features, default manage_options.
Since 0.1.0 · Source: Wyregraf/src/LLM/Provider.php
pngx_wyregraf_llm_model_object #
apply_filters( 'pngx_wyregraf_llm_model_object', \Wyregraf\Libraries\Kambo\Langchain\LLMs\BaseLLM $llm_model, \Profiles $llm_profiles )Filter the llm model object.
$llm_model(\Wyregraf\Libraries\Kambo\Langchain\LLMs\BaseLLM) — An instance of the llm model object.$llm_profiles(\Profiles) — An instance of the LLM profiles.
Since 0.1.0 · Source: Wyregraf/src/LLM/Profiles.php
pngx_wyregraf_llm_options_field_placement_key #
apply_filters( 'pngx_wyregraf_llm_options_field_placement_key', string $, \Options $this )Filters the array key to place the service profile fields.
$(string) — The default array key to place service profile fields.$this(\Options) — This Settings instance.
Since 0.1.0 · Source: Wyregraf/src/LLM/Options.php
pngx_wyregraf_llm_options_fields #
apply_filters( 'pngx_wyregraf_llm_options_fields', array<string,array> $, \Options $options )Filters the options shown to the user for the service.
$(array<string,array>) — A map of the fields for the options page.$options(\Options) — An Options instance.
Since 0.1.0 · Source: Wyregraf/src/LLM/Options.php
pngx_wyregraf_llm_panel_fields #
apply_filters( 'pngx_wyregraf_llm_panel_fields', (string|mixed)[] $panel_fields, (string|mixed)[] $profile_data )Filter the panel fields for the llm profile.
$panel_fields((string|mixed)[]) — The array of panel fields.$profile_data((string|mixed)[]) — The profile data.
Since 0.1.0 · Source: Wyregraf/src/LLM/Profiles.php
pngx_wyregraf_llm_profile_anthropic_panel_fields_placement_key #
apply_filters( 'pngx_wyregraf_llm_profile_anthropic_panel_fields_placement_key', string $, \LLM_Api $this )Filters the array key to place the Anthropic llm panel fields.
$(string) — The default array key to place the Anthropic llm panel fields.$this(\LLM_Api) — This Api instance.
Since 0.5.0 · Source: Wyregraf/src/Services/Anthropic/LLM_Api.php
pngx_wyregraf_llm_profile_openai_panel_fields_placement_key #
apply_filters( 'pngx_wyregraf_llm_profile_openai_panel_fields_placement_key', string $, \LLM_Api $this )Filters the array key to place the OpenAI llm panel fields.
$(string) — The default array key to place the OpenAI llm panel fields.$this(\LLM_Api) — This Api instance.
Since 0.1.0 · Source: Wyregraf/src/Services/OpenAI/LLM_Api.php
pngx_wyregraf_manager #
apply_filters( 'pngx_wyregraf_manager', array<string,string> $map )Allows filtering of LLM APIs.
$map(array<string,string>) — The map of Services.
Since 0.1.0 · Source: Wyregraf/src/Services/Manager.php
pngx_wyregraf_max_attempts #
apply_filters( 'pngx_wyregraf_max_attempts', int $max_attempts )Filter the maximum number of attempts for query processing.
$max_attempts(int) — The default maximum number of attempts.
Since 0.5.0 · Source: Wyregraf/src/LLM/Traits/Setup.php
pngx_wyregraf_max_document_bytes #
apply_filters( 'pngx_wyregraf_max_document_bytes', int $max_bytes )Filters the maximum byte length stored in a chunk’s document and filtered-document columns.
Longer text is truncated with a logged diagnostic rather than dropped. The document source and retrieval text columns are not limited by this value.
$max_bytes(int) — Maximum bytes per column. Default Abstract_Collection::MAX_DOCUMENT_BYTES (16777215).
Source: Wyregraf/src/Vector_Stores/Abstract_Collection.php
pngx_wyregraf_message_history_limit #
apply_filters( 'pngx_wyregraf_message_history_limit', int $limit, string $subChatUuid )Filters how many recent messages load with a subchat (and via REST GET /messages).
Unbounded history made every widget load fetch (and downstream, send) the whole conversation.
$limit(int) — The maximum number of most-recent messages. Default 100.$subChatUuid(string) — The subchat UUID.
Since TBD · Source: Wyregraf/src/Database/Handlers/Subchats.php
pngx_wyregraf_meta_tabs #
apply_filters( 'pngx_wyregraf_meta_tabs', (string)[] $tabs )Filter the Wyregraf Meta Tab Header
$tabs((string)[]) — an array of tab headings.
Since 0.1.0 · Source: Wyregraf/src/Chats/Meta.php
pngx_wyregraf_models_pricing #
apply_filters( 'pngx_wyregraf_models_pricing', (string|mixed)[] $models )Filter the services pricing.
$models((string|mixed)[]) — An array of the services prices.
Since 0.1.0 · Source: Wyregraf/src/LLM/Traits/Utilities.php
pngx_wyregraf_nav_regex #
apply_filters( 'pngx_wyregraf_nav_regex', string $nav_regex )Filter the regex pattern for nav tags removal.
$nav_regex(string) — The regex pattern for nav tags removal.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_normalized_questions #
apply_filters( 'pngx_wyregraf_normalized_questions', string[] $questions, string $raw )Filter the normalized questions extracted from a raw LLM response.
$questions(string[]) — The normalized questions.$raw(string) — The raw LLM response they came from.
Since TBD · Source: Wyregraf/src/Embeddings/Question_Normalizer.php
pngx_wyregraf_openai_embeddings_models #
apply_filters( 'pngx_wyregraf_openai_embeddings_models', array $default_models )Filter the openai embeddings models.
$default_models(array) — The default array of openai models.
Since 0.1.0 · Source: Wyregraf/src/Services/OpenAI/Embeddings_Api.php
pngx_wyregraf_openai_embeddings_models_pricing #
apply_filters( 'pngx_wyregraf_openai_embeddings_models_pricing', (string|mixed)[] $open_ai_models )Filter the OpenAI models for pricing.
$open_ai_models((string|mixed)[]) — The array of OpenAI models for pricing.
Since 0.1.0 · Source: Wyregraf/src/Services/OpenAI/Embeddings_Api.php
pngx_wyregraf_openai_llm_models_pricing #
apply_filters( 'pngx_wyregraf_openai_llm_models_pricing', (string|mixed)[] $openai_models )Filter the OpenAI models for pricing.
$openai_models((string|mixed)[]) — The array of OpenAI models for pricing.
Since 0.1.0 · Source: Wyregraf/src/Services/OpenAI/LLM_Api.php
pngx_wyregraf_openai_models #
apply_filters( 'pngx_wyregraf_openai_models', (string|mixed)[] $openai_models )Filter the OpenAI models.
$openai_models((string|mixed)[]) — The array of OpenAI models.
Since 0.1.0 · Source: Wyregraf/src/Services/OpenAI/LLM_Api.php
pngx_wyregraf_option_sections #
apply_filters( 'pngx_wyregraf_option_sections', array $sections )Filter Option Tabs
$sections(array) — an array of Option tab names and ids
Source: Wyregraf/src/Admin/Options.php
pngx_wyregraf_picture_regex #
apply_filters( 'pngx_wyregraf_picture_regex', string $picture_regex )Filter the regex pattern for picture tags removal.
$picture_regex(string) — The regex pattern for picture tags removal.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_planner_candidate_depth #
apply_filters( 'pngx_wyregraf_planner_candidate_depth', int $depth )Filters how many candidates each planned sub-query retrieves before fusion.
The value is clamped to the range 1-100 and never falls below the requested result count.
$depth(int) — The candidate depth per sub-query. Default 20.
Source: Wyregraf/src/Vector_Stores/Simple_MySQL/Vector_Store.php
pngx_wyregraf_planner_subquery_limit #
apply_filters( 'pngx_wyregraf_planner_subquery_limit', int $limit )Filters the maximum number of planner sub-queries kept from the provider output.
The value is clamped to the range 0-4.
$limit(int) — The maximum number of sub-queries. Default 4.
Source: Wyregraf/src/Retrieval/Query_Planner.php
pngx_wyregraf_post_embeddings_meta_fields #
apply_filters( 'pngx_wyregraf_post_embeddings_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the post meta fields for embeddings
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.1.0 · Source: Wyregraf/src/Sources/Posts/Meta_Fields.php
pngx_wyregraf_post_loader_content #
apply_filters( 'pngx_wyregraf_post_loader_content', string $content, \WP_Post $post )Filter the embedding content to create embeddings with before clean up and markdown conversion.
$content(string) — The content from the post, page, or custom post type to create embeddings.$post(\WP_Post) — The post object.
Since 0.1.0 · Source: Wyregraf/src/Sources/Posts/Post_Loader.php
pngx_wyregraf_post_loader_content_converted #
apply_filters( 'pngx_wyregraf_post_loader_content_converted', string $content, \WP_Post $post )Filter the embedding content to create embeddings with after clean up and markdown conversion.
$content(string) — The content from the post, page, or custom post type to create embeddings.$post(\WP_Post) — The post object.
Since 0.1.0 · Source: Wyregraf/src/Sources/Posts/Post_Loader.php
pngx_wyregraf_post_loader_content_converted_type_ #
apply_filters( 'pngx_wyregraf_post_loader_content_converted_type_', string $filtered_content, string $content )Filter the post/page/custom post filtered content to use in previews.
$filtered_content(string) — The content from the post, page, or custom post type to use in previews.$content(string) — The original source.
Since 0.2.0 · Source: Wyregraf/src/Sources/Posts/Post_Loader.php
pngx_wyregraf_post_loader_content_converted_type_{$post_type} #
apply_filters( 'pngx_wyregraf_post_loader_content_converted_type_{$post_type}', string $content, \WP_Post $post )Filter the embedding content by post type after clean up and markdown conversion.
$content(string) — The content from the post, page, or custom post type to create embeddings.$post(\WP_Post) — The post object.
Since 0.1.0 · Source: Wyregraf/src/Sources/Posts/Post_Loader.php
pngx_wyregraf_post_loader_content_type_{$post_type} #
apply_filters( 'pngx_wyregraf_post_loader_content_type_{$post_type}', string $content, \WP_Post $post )Filter the embedding content by post type before clean up and markdown conversion.
$content(string) — The content from the post, page, or custom post type to create embeddings.$post(\WP_Post) — The post object.
Since 0.1.0 · Source: Wyregraf/src/Sources/Posts/Post_Loader.php
pngx_wyregraf_pre_embed_documents #
apply_filters( 'pngx_wyregraf_pre_embed_documents', array $subDocs, array $embedding_data, int $embeddings_post_id )Final public transform seam immediately before standard documents are embedded.
Built-in asynchronous enrichment runs before this point. Returning anything other than an array leaves the last valid document set unchanged.
$subDocs(array) — Standard Document objects.$embedding_data(array) — Queue payload.$embeddings_post_id(int) — Source configuration ID.
Source: Wyregraf/src/Process/Embeddings_Queue.php
pngx_wyregraf_pro_agent_convert_html_entities_encoding #
apply_filters( 'pngx_wyregraf_pro_agent_convert_html_entities_encoding', string $encoding )Filter the encoding used in html_entity_decode for agent system prompt input variable.
$encoding(string) — The encoding for html_entity_decode. Default is ‘UTF-8’.
Since TBD · Source: Wyregraf_Pro/src/Agents/Types/Abstract_Agent.php
pngx_wyregraf_pro_agent_convert_html_entities_flags #
apply_filters( 'pngx_wyregraf_pro_agent_convert_html_entities_flags', int $flags )Filter the flags used in html_entity_decode for agent system prompt input variable.
$flags(int) — The flags for html_entity_decode. Default is ENT_QUOTES | ENT_HTML401.
Since TBD · Source: Wyregraf_Pro/src/Agents/Types/Abstract_Agent.php
pngx_wyregraf_pro_agent_label_plural #
apply_filters( 'pngx_wyregraf_pro_agent_label_plural', string $label )Filters the menu and list-table name for the Agent post type.
$label(string) — Plural Agent label. Default ‘Agents’.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Post_Type.php
pngx_wyregraf_pro_agent_label_plural_lowercase #
apply_filters( 'pngx_wyregraf_pro_agent_label_plural_lowercase', string $label )Filters the lowercase plural Agent label, used in notices and help text.
$label(string) — Lowercase plural Agent label. Default ‘agents’.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Post_Type.php
pngx_wyregraf_pro_agent_label_singular #
apply_filters( 'pngx_wyregraf_pro_agent_label_singular', string $label )Filters the name shown for a single Agent in the admin.
$label(string) — Singular Agent label. Default ‘Agent’.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Post_Type.php
pngx_wyregraf_pro_agent_label_singular_lowercase #
apply_filters( 'pngx_wyregraf_pro_agent_label_singular_lowercase', string $label )Filters the lowercase form of the singular Agent label, used mid-sentence.
$label(string) — Lowercase singular Agent label. Default ‘agent’.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Post_Type.php
pngx_wyregraf_pro_agent_meta_tabs #
apply_filters( 'pngx_wyregraf_pro_agent_meta_tabs', (string)[] $tabs )Filter the Wyregraf Meta Tab Header
$tabs((string)[]) — an array of tab headings.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Meta.php
pngx_wyregraf_pro_agents_ajax_query_args #
apply_filters( 'pngx_wyregraf_pro_agents_ajax_query_args', (string|mixed)[] $args, string $selected, (string|mixed)[] $search, int $page )Filter the query arguments before running WP_Query.
$args((string|mixed)[]) — The query arguments for WP_Query.$selected(string) — The selected value.$search((string|mixed)[]) — The search parameters.$page(int) — The current page number.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Ajax.php
pngx_wyregraf_pro_agents_meta_fields #
apply_filters( 'pngx_wyregraf_pro_agents_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the meta fields for the post type.
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Meta_Fields.php
pngx_wyregraf_pro_agents_slug #
apply_filters( 'pngx_wyregraf_pro_agents_slug', string $slug )Provides an opportunity to modify the agent slug.
$slug(string) — The sanitized slug from the options page.
Since 0.5.0 · Source: Wyregraf_Pro/src/Agents/Post_Type.php
pngx_wyregraf_pro_chat_endpoints #
apply_filters( 'pngx_wyregraf_pro_chat_endpoints', array<string,string> $endpoints )Filters the chat endpoints URLs.
$endpoints(array<string,string>) — An array of endpoint URLs.
Since TBD · Source: Wyregraf_Pro/src/Chat/Shortcode/Vectors.php
pngx_wyregraf_pro_chat_session_handler #
apply_filters( 'pngx_wyregraf_pro_chat_session_handler', string $ )Allows filtering the class to clean up the chats session table.
$(string) — The default class name.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Provider.php
pngx_wyregraf_pro_chat_show_error_details #
apply_filters( 'pngx_wyregraf_pro_chat_show_error_details', bool $can_see_details, string[] $error_messages )Filters whether the current user may see detailed chat error messages.
Defaults to site administrators. Other users see the generic message.
$can_see_details(bool) — Whether to expose the underlying error detail.$error_messages(string[]) — The underlying error message(s).
Since 0.5.1 · Source: Wyregraf_Pro/src/Chat/Agents.php
pngx_wyregraf_pro_chats_meta_fields #
apply_filters( 'pngx_wyregraf_pro_chats_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the meta fields for the post type.
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.3.0 · Source: Wyregraf_Pro/src/Chat/Meta_Fields.php
pngx_wyregraf_pro_code_embeddings_meta_fields #
apply_filters( 'pngx_wyregraf_pro_code_embeddings_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the code meta fields for embeddings
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Meta_Fields.php
pngx_wyregraf_pro_code_embeddings_zip_max_entries #
apply_filters( 'pngx_wyregraf_pro_code_embeddings_zip_max_entries', int $max_entries )Filter the maximum number of zip entries processed in a Code ingest.
$max_entries(int) — The maximum number of zip entries. Default 10000.
Since 0.5.1 · Source: Wyregraf_Pro/src/Sources/Code/Zip_File_Processor.php
pngx_wyregraf_pro_code_embeddings_zip_max_total_bytes #
apply_filters( 'pngx_wyregraf_pro_code_embeddings_zip_max_total_bytes', int $max_total_bytes )Filter the maximum total uncompressed bytes collected from a Code ingest zip.
$max_total_bytes(int) — The maximum total uncompressed bytes. Default 128 MB.
Since 0.5.1 · Source: Wyregraf_Pro/src/Sources/Code/Zip_File_Processor.php
pngx_wyregraf_pro_code_loader_content #
apply_filters( 'pngx_wyregraf_pro_code_loader_content', string[] $process_code, \WP_Post $post )Filter the Code files to create embeddings with.
$process_code(string[]) — The code files.$post(\WP_Post) — The post object.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Code_Loader.php
pngx_wyregraf_pro_get_code_excluded_dirs #
apply_filters( 'pngx_wyregraf_pro_get_code_excluded_dirs', array $excluded_dirs )Filters the list of directories to exclude.
$excluded_dirs(array) — The list of directories to exclude.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Traits/Exclusions.php
pngx_wyregraf_pro_get_code_excluded_file_types #
apply_filters( 'pngx_wyregraf_pro_get_code_excluded_file_types', array $excluded_file_types )Filters the list of file types to exclude.
$excluded_file_types(array) — The list of file types to exclude.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Traits/Exclusions.php
pngx_wyregraf_pro_get_code_excluded_files #
apply_filters( 'pngx_wyregraf_pro_get_code_excluded_files', array $excluded_files )Filters the list of files to exclude.
$excluded_files(array) — The list of files to exclude.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Traits/Exclusions.php
pngx_wyregraf_pro_get_code_zip_max_file_size #
apply_filters( 'pngx_wyregraf_pro_get_code_zip_max_file_size', string $max_file_size )Filter the zip code file max file size.
$max_file_size(string) — The zip code file max file size.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Traits/Exclusions.php
pngx_wyregraf_pro_get_code_zip_minified_assets_regex #
apply_filters( 'pngx_wyregraf_pro_get_code_zip_minified_assets_regex', string $remove_minified_assets )Filter the regex pattern for removing minified assets.
$remove_minified_assets(string) — The regex pattern for removing minified assets.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Traits/Exclusions.php
pngx_wyregraf_pro_get_code_zip_minimum_file_size #
apply_filters( 'pngx_wyregraf_pro_get_code_zip_minimum_file_size', string $max_file_size )Filter the zip code file minimum file size.
$max_file_size(string) — The zip code file minimum file size.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Traits/Exclusions.php
pngx_wyregraf_pro_network_label_plural #
apply_filters( 'pngx_wyregraf_pro_network_label_plural', string $label )Filters the plural Network name used for the admin menu and list table.
$label(string) — The plural Network name. Default ‘Networks’.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Post_Type.php
pngx_wyregraf_pro_network_label_plural_lowercase #
apply_filters( 'pngx_wyregraf_pro_network_label_plural_lowercase', string $label )Filters the plural Network name in lowercase for notices and help text.
$label(string) — The lowercase plural Network name. Default ‘networks’.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Post_Type.php
pngx_wyregraf_pro_network_label_singular #
apply_filters( 'pngx_wyregraf_pro_network_label_singular', string $label )Filters how one Network is named in admin screens.
$label(string) — The singular Network name. Default ‘Network’.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Post_Type.php
pngx_wyregraf_pro_network_label_singular_lowercase #
apply_filters( 'pngx_wyregraf_pro_network_label_singular_lowercase', string $label )Filters the singular Network name in lowercase for use inside sentences.
$label(string) — The lowercase singular Network name. Default ‘network’.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Post_Type.php
pngx_wyregraf_pro_networks_ajax_query_args #
apply_filters( 'pngx_wyregraf_pro_networks_ajax_query_args', (string|mixed)[] $args, string $selected, (string|mixed)[] $search, int $page )Filter the query arguments before running WP_Query.
$args((string|mixed)[]) — The query arguments for WP_Query.$selected(string) — The selected value.$search((string|mixed)[]) — The search parameters.$page(int) — The current page number.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Ajax.php
pngx_wyregraf_pro_networks_meta_fields #
apply_filters( 'pngx_wyregraf_pro_networks_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the meta fields for the post type.
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Meta_Fields.php
pngx_wyregraf_pro_networks_meta_tabs #
apply_filters( 'pngx_wyregraf_pro_networks_meta_tabs', (string)[] $tabs )Filter the Wyregraf Meta Tab Header
$tabs((string)[]) — an array of tab headings.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Meta.php
pngx_wyregraf_pro_networks_slug #
apply_filters( 'pngx_wyregraf_pro_networks_slug', string $slug )Provides an opportunity to modify the network slug.
$slug(string) — The sanitized slug from the options page.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Post_Type.php
pngx_wyregraf_pro_pdf_smalot_embeddings_meta_fields #
apply_filters( 'pngx_wyregraf_pro_pdf_smalot_embeddings_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the pdf meta fields for embeddings
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.1.0 · Source: Wyregraf_Pro/src/Sources/PDF/Smalot/Meta_Fields.php
pngx_wyregraf_pro_pdf_smalot_loader_content #
apply_filters( 'pngx_wyregraf_pro_pdf_smalot_loader_content', string $content, \WP_Post $post )Filter the pdf content to create embeddings with.
$content(string) — The content from the post, page, or custom post type to create embeddings.$post(\WP_Post) — The post object.
Since 0.1.0 · Source: Wyregraf_Pro/src/Sources/PDF/Smalot/PDF_Loader.php
pngx_wyregraf_pro_set_code_embeddings_zip_excluded_directories #
apply_filters( 'pngx_wyregraf_pro_set_code_embeddings_zip_excluded_directories', string $excluded_dirs )Filter the exclude directories for code source.
$excluded_dirs(string) — A comma separated list of directories to exclude.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Zip_File_Processor.php
pngx_wyregraf_pro_set_code_embeddings_zip_excluded_files #
apply_filters( 'pngx_wyregraf_pro_set_code_embeddings_zip_excluded_files', string $excluded_files )Filter the exclude files for code source.
$excluded_files(string) — A comma separated list of files to exclude.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Zip_File_Processor.php
pngx_wyregraf_pro_set_code_embeddings_zip_excluded_filetypes #
apply_filters( 'pngx_wyregraf_pro_set_code_embeddings_zip_excluded_filetypes', string $excluded_filetypes )Filter the exclude directories for code source.
$excluded_filetypes(string) — A comma separated list of directories to exclude.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Zip_File_Processor.php
pngx_wyregraf_pro_set_code_embeddings_zip_excluded_full_paths #
apply_filters( 'pngx_wyregraf_pro_set_code_embeddings_zip_excluded_full_paths', string $excluded_full_paths )Filter the exclude directories for code source.
$excluded_full_paths(string) — A comma separated list of directories to exclude.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Zip_File_Processor.php
pngx_wyregraf_pro_set_code_embeddings_zip_max_file_size #
apply_filters( 'pngx_wyregraf_pro_set_code_embeddings_zip_max_file_size', int $max_file_size )Filter the max file size set in Zip File Processor.
$max_file_size(int) — The zip code file max file size.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Zip_File_Processor.php
pngx_wyregraf_pro_set_code_embeddings_zip_minimum_file_size #
apply_filters( 'pngx_wyregraf_pro_set_code_embeddings_zip_minimum_file_size', int $minimum_file_size )Filter the minimum file size set in Zip File Processor.
$minimum_file_size(int) — The zip code file minimum file size.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Zip_File_Processor.php
pngx_wyregraf_pro_tool_' . Identifier::TOOL_ID . '_meta_fields #
apply_filters( 'pngx_wyregraf_pro_tool_' . Identifier::TOOL_ID . '_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the meta fields for the tool.
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.5.0 · Source: Wyregraf_Pro/src/Tools/Types/Retrieval/Meta_Fields.php
pngx_wyregraf_pro_url_scrape_embeddings_meta_fields #
apply_filters( 'pngx_wyregraf_pro_url_scrape_embeddings_meta_fields', array $fields, string $fields_prefix, int $post_id )Filter the url scrape meta fields for embeddings
$fields(array) — an array of fields to display in meta tabs.$fields_prefix(string) — The string of the meta prefix.$post_id(int) — The post id for the meta.
Since 0.2.0 · Source: Wyregraf_Pro/src/Sources/URL_Scrape/Meta_Fields.php
pngx_wyregraf_pro_url_scrape_loader_content #
apply_filters( 'pngx_wyregraf_pro_url_scrape_loader_content', string $content, \WP_Post $post )Filter the URL scrape content to create embeddings with.
$content(string) — The content from the post, page, or custom post type to create embeddings.$post(\WP_Post) — The post object.
Since 0.2.0 · Source: Wyregraf_Pro/src/Sources/URL_Scrape/URL_Scrape_Loader.php
pngx_wyregraf_pro_url_scrape_loader_filtered_content #
apply_filters( 'pngx_wyregraf_pro_url_scrape_loader_filtered_content', string $document_filtered, string $content )Filter the URL scrape filtered content to use in previews.
$document_filtered(string) — The content from the url to use in previews.$content(string) — The original source.
Since 0.5.0 · Source: Wyregraf_Pro/src/Sources/URL_Scrape/URL_Scrape_Loader.php
pngx_wyregraf_pro_use_evaluation_agent #
apply_filters( 'pngx_wyregraf_pro_use_evaluation_agent', bool $use_evaluation, \Abstract_Agent $evaluation_agent, \Output $output )Filter whether to use evaluation agent.
$use_evaluation(bool) — Whether to use evaluation (default: true).$evaluation_agent(\Abstract_Agent) — The evaluation agent instance.$output(\Output) — The current output object.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Pipeline/Agent_Handler.php
pngx_wyregraf_pro_use_fallback_agent #
apply_filters( 'pngx_wyregraf_pro_use_fallback_agent', bool $use_fallback, \Abstract_Agent $fallback_agent, \Output $output )Filter whether to use fallback agent.
$use_fallback(bool) — Whether to use fallback (default: has errors).$fallback_agent(\Abstract_Agent) — The fallback agent instance.$output(\Output) — The current output object.
Since 0.5.0 · Source: Wyregraf_Pro/src/Networks/Pipeline/Agent_Handler.php
pngx_wyregraf_prompt_default_chat_prompt #
apply_filters( 'pngx_wyregraf_prompt_default_chat_prompt', string $chat_prompt )Filter the the default chat prompt.
$chat_prompt(string) — The default retrieval prompt text.
Since 0.1.0 · Source: Wyregraf/src/Prompts/Traits/Prompt_Utilities.php
pngx_wyregraf_prompt_default_questions_prompt #
apply_filters( 'pngx_wyregraf_prompt_default_questions_prompt', string $questions_prompt )Filter the default questions prompt.
$questions_prompt(string) — The default questions prompt text.
Since TBD · Source: Wyregraf/src/Prompts/Traits/Prompt_Utilities.php
pngx_wyregraf_prompt_default_retrieval_prompt #
apply_filters( 'pngx_wyregraf_prompt_default_retrieval_prompt', string $retrieval_prompt )Filter the default retrieval prompt.
$retrieval_prompt(string) — The default retrieval prompt text.
Since 0.1.0 · Source: Wyregraf/src/Prompts/Traits/Prompt_Utilities.php
pngx_wyregraf_prompt_default_summary_prompt #
apply_filters( 'pngx_wyregraf_prompt_default_summary_prompt', string $summary_prompt )Filter the default summary prompt.
$summary_prompt(string) — The default summary prompt text.
Since TBD · Source: Wyregraf/src/Prompts/Traits/Prompt_Utilities.php
pngx_wyregraf_prompt_default_system_prompt #
apply_filters( 'pngx_wyregraf_prompt_default_system_prompt', string $system_prompt )Filter the default system prompt.
$system_prompt(string) — The default retrieval prompt text.
Since 0.1.0 · Source: Wyregraf/src/Prompts/Traits/Prompt_Utilities.php
pngx_wyregraf_prompt_label_plural #
apply_filters( 'pngx_wyregraf_prompt_label_plural', string $label )Filters the plural Prompt label shown in the admin menu and list table.
$label(string) — Plural label. Default ‘Prompts’.
Since 0.7.1 · Source: Wyregraf/src/Prompts/Post_Type.php
pngx_wyregraf_prompt_label_plural_lowercase #
apply_filters( 'pngx_wyregraf_prompt_label_plural_lowercase', string $label )Filters the lowercase plural Prompt label for notices and help text.
$label(string) — Lowercase plural label. Default ‘prompts’.
Since 0.7.1 · Source: Wyregraf/src/Prompts/Post_Type.php
pngx_wyregraf_prompt_label_singular #
apply_filters( 'pngx_wyregraf_prompt_label_singular', string $label )Filters the singular label of the Prompt post type.
$label(string) — The singular label. Default ‘Prompt’.
Since 0.7.1 · Source: Wyregraf/src/Prompts/Post_Type.php
pngx_wyregraf_prompt_label_singular_lowercase #
apply_filters( 'pngx_wyregraf_prompt_label_singular_lowercase', string $label )Filters the lowercase singular Prompt label used inside sentences.
$label(string) — Lowercase singular label. Default ‘prompt’.
Since 0.7.1 · Source: Wyregraf/src/Prompts/Post_Type.php
pngx_wyregraf_prompt_slug #
apply_filters( 'pngx_wyregraf_prompt_slug', string $slug )Provides an opportunity to modify the wyregraf Vector slug.
$slug(string) — The sanitized slug from the options page.
Since 0.1.0 · Source: Wyregraf/src/Prompts/Post_Type.php
pngx_wyregraf_prompts_ajax_query_args #
apply_filters( 'pngx_wyregraf_prompts_ajax_query_args', (string|mixed)[] $args, string $selected, (string|mixed)[] $search, int $page )Filter the query arguments before running WP_Query.
$args((string|mixed)[]) — The query arguments for WP_Query.$selected(string) — The selected value.$search((string|mixed)[]) — The search parameters.$page(int) — The current page number.
Since 0.1.0 · Source: Wyregraf/src/Prompts/Ajax.php
pngx_wyregraf_query_processor_max_attempts #
apply_filters( 'pngx_wyregraf_query_processor_max_attempts', int $max_attempts )Filter the maximum number of attempts for query processing.
$max_attempts(int) — The default maximum number of attempts.
Since 0.5.0 · Source: Wyregraf_Pro/src/Tools/Types/Query_Processor/Controller.php
pngx_wyregraf_question_queue_count #
apply_filters( 'pngx_wyregraf_question_queue_count', int $batch_size )Filter the Wyregraf batch size for creating question queue.
Each item in the batch costs a blocking LLM round-trip inside a single queue task, so the default is sized to finish within typical PHP/cron time limits (the task also has its own time budget as a backstop).
$batch_size(int) — The batch size for creating question queue, default 5.
Since 0.5.0 · Source: Wyregraf/src/Embeddings/Questions.php
pngx_wyregraf_queue_task_time_budget #
apply_filters( 'pngx_wyregraf_queue_task_time_budget', int $budget, string $identifier )Filters the per-task time budget (seconds) for serial LLM calls in the queues.
Each chunk costs a blocking LLM round-trip; on typical hosting a task must stay within PHP/cron time limits. When the budget is exceeded the unprocessed chunk ids are returned to the queue batch and picked up on the next cycle. 0 disables the budget.
$budget(int) — The budget in seconds. Default 15.$identifier(string) — The queue identifier.
Since TBD · Source: Wyregraf/src/Process/Summary_Queue.php
pngx_wyregraf_quota_policy #
apply_filters( 'pngx_wyregraf_quota_policy', array $buckets, array $identity, int $chat_post_id )Filters the quota buckets applied to a caller.
$buckets(array) — Role-keyed quota buckets (empty = unrestricted).$identity(array) — The caller identity map.$chat_post_id(int) — The chat post id.
Since TBD · Source: Wyregraf/src/Security/Quota_Manager.php
pngx_wyregraf_rate_limit #
apply_filters( 'pngx_wyregraf_rate_limit', array<string,int> $limits, string $context, array<string,string> $ids )Filters the rate limit for a guarded surface.
Return ‘max’ => 0 to disable limiting for the context. The future quota feature hooks here to supply per-plan/per-user limits.
$limits(array<string,int>) — The limit: max requests per window (seconds).$context(string) — The guarded surface slug.$ids(array<string,string>) — The caller identifiers.
Since TBD · Source: Wyregraf/src/Security/Rate_Limiter.php
pngx_wyregraf_rate_limit_ip #
apply_filters( 'pngx_wyregraf_rate_limit_ip', string $ip )Filters the client IP used for rate limiting (e.g. to read a trusted proxy header).
$ip(string) — The client IP.
Since TBD · Source: Wyregraf/src/Security/Rate_Limiter.php
pngx_wyregraf_regenerate_supported_answer #
apply_filters( 'pngx_wyregraf_regenerate_supported_answer', string|null $output, string $question, string $answer, string[] $unsupported, array $sources, int $chat_post_id )Filters the regenerated answer before the accuracy profile is asked to rewrite it.
Return a non-null string to supply the answer and skip the built-in LLM call.
$output(string|null) — The regenerated answer, or null to use the accuracy profile.$question(string) — The user question.$answer(string) — The answer that contains unsupported claims.$unsupported(string[]) — The unsupported claims.$sources(array) — The untouched evidence documents.$chat_post_id(int) — The chat post ID.
Source: Wyregraf/src/Grounding/Citation_Integrity.php
pngx_wyregraf_rerank_candidates #
apply_filters( 'pngx_wyregraf_rerank_candidates', array|null $output, string $strategy, string $query, array $pool, string[] $ids, int $chat_post_id )Filters the reranker output for the current candidate pool.
Return an ordered list of candidate IDs, each supplied ID exactly once, to supply or replace the ranking. Candidate text is untrusted data, never instructions.
$output(array|null) — The ordered candidate IDs from the provider, or null when no provider ran.$strategy(string) — The reranker strategy, ‘llm’ or ‘voyage’.$query(string) — The user query.$pool(array) — The candidate pool being reranked.$ids(string[]) — The candidate IDs in pool order.$chat_post_id(int) — The chat post ID.
Source: Wyregraf/src/Retrieval/Reranker.php
pngx_wyregraf_reranker_candidate_depth #
apply_filters( 'pngx_wyregraf_reranker_candidate_depth', int $depth )Filters how many fused candidates are passed to the reranker.
The value is clamped to the range 1-100.
$depth(int) — The number of candidates to rerank. Default 20.
Source: Wyregraf/src/Retrieval/Reranker.php
pngx_wyregraf_reranker_provider #
apply_filters( 'pngx_wyregraf_reranker_provider' )Return an ordered list of the exact candidate IDs. Candidate text is data, never instructions; adapters are responsible for provider-specific calls.
Source: Wyregraf/src/Retrieval/Reranker.php
pngx_wyregraf_retrieval_backfill_batch_size #
apply_filters( 'pngx_wyregraf_retrieval_backfill_batch_size', int $batch_size )Filters how many chunk rows one retrieval-text backfill pass processes.
The value is clamped to the range 1-1000.
$batch_size(int) — The rows per pass. Default 250.
Source: Wyregraf/src/Process/Retrieval_Text_Backfill_Queue.php
pngx_wyregraf_retrieval_document_overview #
apply_filters( 'pngx_wyregraf_retrieval_document_overview', string|null $overview, \Document $document, int $embeddings_post_id )Filters the overview used as enrichment context for a document that exceeds the context budget.
Return a non-empty string to skip the built-in LLM overview generation.
$overview(string|null) — The overview text, or null to generate one.$document(\Document) — The source document.$embeddings_post_id(int) — The embeddings (source) post ID.
Source: Wyregraf/src/Process/Retrieval_Enrichment_Queue.php
pngx_wyregraf_retrieval_enrichment_output #
apply_filters( 'pngx_wyregraf_retrieval_enrichment_output', mixed $output, \Document $chunk, string $context, array $enabled, int $embeddings_post_id )Filters the raw enrichment output for a chunk before the built-in LLM call.
Return a non-null value to supply the provider output and skip the LLM call.
$output(mixed) — The enrichment output, or null to call the LLM.$chunk(\Document) — The retrieval chunk being enriched.$context(string) — The bounded document context.$enabled(array) — The enabled enrichment outputs keyed by setting name.$embeddings_post_id(int) — The embeddings (source) post ID.
Source: Wyregraf/src/Process/Retrieval_Enrichment_Queue.php
pngx_wyregraf_retrieval_namespace #
apply_filters( 'pngx_wyregraf_retrieval_namespace', int[] $term_ids, int $chat_post_id, \Embeddings_Profiles $embeddings_profile )Filter the term ids to use with the retrieval.
$term_ids(int[]) — An array of term ids.$chat_post_id(int) — The chat post id.$embeddings_profile(\Embeddings_Profiles) — An instance of the Embeddings Service Profiles.
Since 0.1.0 · Source: Wyregraf/src/Chats/Api.php
pngx_wyregraf_rrf_constant #
apply_filters( 'pngx_wyregraf_rrf_constant', int $constant )Filters the Reciprocal Rank Fusion constant used to merge dense and lexical rankings.
A larger constant flattens the score gap between top and lower ranks. Values below 1 are raised to 1.
$constant(int) — The RRF constant. Default 60.
Source: Wyregraf/src/Vector_Stores/Simple_MySQL/Collection.php
pngx_wyregraf_script_regex #
apply_filters( 'pngx_wyregraf_script_regex', string $script_regex )Filter the regex pattern for script tags removal.
$script_regex(string) — The regex pattern for script tags removal.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_search_cache_ttl #
apply_filters( 'pngx_wyregraf_search_cache_ttl', int $ttl )Filters the similarity-search result cache TTL in seconds. 0 disables caching.
$ttl(int) — The TTL. Default 900 (15 minutes).
Since TBD · Source: Wyregraf/src/Vector_Stores/Simple_MySQL/Collection.php
pngx_wyregraf_search_candidate_limit #
apply_filters( 'pngx_wyregraf_search_candidate_limit', int $limit )Filters the maximum number of binary-prefilter candidates fed to the cosine rerank.
Defaults to the admin-configurable “Rerank candidate depth” option (Options → Indexing & Retrieval), falling back to 500 when unset.
$limit(int) — The candidate cap. Default is the configured option or 500.
Since TBD · Source: Wyregraf/src/Vector_Stores/Simple_MySQL/Collection.php
pngx_wyregraf_sentence_rows_retrievable #
apply_filters( 'pngx_wyregraf_sentence_rows_retrievable', bool $retrievable, int $embeddings_post_id )Sentence rows join dense retrieval only when explicitly enabled; the default keeps the pre-hybrid behavior where only chunk rows have term rows and are reachable by search.
$retrievable(bool) — Whether sentence rows receive namespace terms.$embeddings_post_id(int) — The embeddings source post ID.
Source: Wyregraf/src/Vector_Stores/Abstract_Collection.php
pngx_wyregraf_setup_default_properties #
apply_filters( 'pngx_wyregraf_setup_default_properties', array<string,string> $properties, string $kind, string $service )Filters the default properties for a wizard-created provider profile.
$properties(array<string,string>) — The default properties, key included.$kind(string) — llm|embeddings.$service(string) — The provider service slug.
Since 0.7.0 · Source: Wyregraf/src/Onboarding/Ajax.php
pngx_wyregraf_simple_mysql_database_install_capabilities_check #
apply_filters( 'pngx_wyregraf_simple_mysql_database_install_capabilities_check', string $ajax_capability )Allows filtering of the capability required to use reinstall the database.
$ajax_capability(string) — The capability required to use the ajax features, default manage_options.
Since 0.1.0 · Source: Wyregraf/src/Database/Controller.php
pngx_wyregraf_simple_mysql_enabled #
apply_filters( 'pngx_wyregraf_simple_mysql_enabled', bool $activate )Allows filtering whether the Simple MySQL should be activated or not.
Note: this filter will only apply if the disable constant or env var are not set or are set to falsy values.
$activate(bool) — Defaults to <code>true</code>.
Since 0.1.0 · Source: Wyregraf/src/Vector_Stores/Simple_MySQL/Provider.php
pngx_wyregraf_slug #
apply_filters( 'pngx_wyregraf_slug', string $slug )Provides an opportunity to modify the wyregraf Vector slug.
$slug(string) — The sanitized slug from the options page.
Since 0.1.0 · Source: Wyregraf/src/Chats/Post_Type.php
pngx_wyregraf_source_{$embedding_data['source_type']}_model_object #
apply_filters( 'pngx_wyregraf_source_{$embedding_data['source_type']}_model_object', \Wyregraf\Libraries\Kambo\Langchain\Embeddings $embeddings_model, \Profiles $embedding_data )Filter the source post embeddings model object.
$embeddings_model(\Wyregraf\Libraries\Kambo\Langchain\Embeddings) — An instance of the embeddings model object.$embedding_data(\Profiles) — [‘additionalParams’][’embeddings_profile’] An instance of the Embeddings profiles.
Since 0.4.0 · Source: Wyregraf/src/Process/Embeddings_Queue.php
pngx_wyregraf_source_{$source_type}_model_object #
apply_filters( 'pngx_wyregraf_source_{$source_type}_model_object', \Wyregraf\Libraries\Kambo\Langchain\Embeddings $embeddings_model, \Profiles $embedding_data )Filter the source post embeddings model object.
$embeddings_model(\Wyregraf\Libraries\Kambo\Langchain\Embeddings) — An instance of the embeddings model object.$embedding_data(\Profiles) — [‘additionalParams’][’embeddings_profile’] An instance of the Embeddings profiles.
Since 0.5.0 · Source: Wyregraf/src/Embeddings/Traits/Setup.php
pngx_wyregraf_source_{$this->source_id}_model_object #
apply_filters( 'pngx_wyregraf_source_{$this->source_id}_model_object', \Wyregraf\Libraries\Kambo\Langchain\Embeddings $embeddings_model, \Profiles $data )Filter the source post embeddings model object.
$embeddings_model(\Wyregraf\Libraries\Kambo\Langchain\Embeddings) — An instance of the embeddings model object.$data(\Profiles) — [’embeddings_profile’] An instance of the Embeddings profiles.
Since 0.4.0 · Source: Wyregraf_Pro/src/Sources/Code/Controller.php
pngx_wyregraf_source_internal_model_object #
apply_filters( 'pngx_wyregraf_source_internal_model_object', \Wyregraf\Libraries\Kambo\Langchain\Embeddings $embeddings_model, \Profiles $data )Filter the source internal embeddings model object.
$embeddings_model(\Wyregraf\Libraries\Kambo\Langchain\Embeddings) — An instance of the embeddings model object.$data(\Profiles) — [’embeddings_profile’] An instance of the Embeddings profiles.
Since 0.4.0 · Source: Wyregraf/src/Sources/Internal/Controller.php
pngx_wyregraf_source_post_model_object #
apply_filters( 'pngx_wyregraf_source_post_model_object', \Wyregraf\Libraries\Kambo\Langchain\Embeddings $embeddings_model, \Profiles $data )Filter the source post embeddings model object.
$embeddings_model(\Wyregraf\Libraries\Kambo\Langchain\Embeddings) — An instance of the embeddings model object.$data(\Profiles) — [’embeddings_profile’] An instance of the Embeddings profiles.
Since 0.1.0 · Source: Wyregraf/src/Sources/Posts/Controller.php
pngx_wyregraf_span_regex #
apply_filters( 'pngx_wyregraf_span_regex', string $span_regex )Filter the regex pattern for span tags removal.
$span_regex(string) — The regex pattern for span tags removal.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_starter_questions_cache_ttl #
apply_filters( 'pngx_wyregraf_starter_questions_cache_ttl', int $ttl )Filters the starter-question pool cache TTL in seconds. 0 disables caching.
$ttl(int) — The TTL. Default 900 (15 minutes).
Since TBD · Source: Wyregraf/src/Chats/Questions.php
pngx_wyregraf_strip_html_anchors_in_citations_regex #
apply_filters( 'pngx_wyregraf_strip_html_anchors_in_citations_regex', string $anchor_regex )Filter the regex pattern for stripping HTML anchor tags in citations.
$anchor_regex(string) — The regex pattern for stripping HTML anchor tags in citations.
Since 0.1.0 · Source: Wyregraf/src/Prompts/Traits/Prompt_Utilities.php
pngx_wyregraf_style_regex #
apply_filters( 'pngx_wyregraf_style_regex', string $style_regex )Filter the regex pattern for style tags removal.
$style_regex(string) — The regex pattern for style tags removal.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_summary_queue_count #
apply_filters( 'pngx_wyregraf_summary_queue_count', int $batch_size )Filter the Wyregraf batch size for creating summary queue.
Each item in the batch costs a blocking LLM round-trip inside a single queue task, so the default is sized to finish within typical PHP/cron time limits (the task also has its own time budget as a backstop).
$batch_size(int) — The batch size for creating summary queue, default 5.
Since 0.5.0 · Source: Wyregraf/src/Embeddings/Summary.php
pngx_wyregraf_supported_system_version #
apply_filters( 'pngx_wyregraf_supported_system_version', string $system, bool $supported )Filter whether the current version of PHP or WordPress is supported.
$system(string) — Which system to test the version of such as ‘php’ or ‘WordPress’.$supported(bool) — Whether the current version of PHP or WordPress is supported.
Since 0.1.0 · Source: Wyregraf/src/Plugin.php
pngx_wyregraf_svg_regex #
apply_filters( 'pngx_wyregraf_svg_regex', string $svg_regex )Filter the regex pattern for svg tags removal.
$svg_regex(string) — The regex pattern for svg tags removal.
Since 0.1.0 · Source: Wyregraf/src/Sources/Abstract_Post_Loader.php
pngx_wyregraf_taxonomy_slug #
apply_filters( 'pngx_wyregraf_taxonomy_slug', string $slug )Provides an opportunity to modify the taxonomy slug.
$slug(string) — The sanitized slug from the options page.
Since 0.1.0 · Source: Wyregraf/src/Taxonomy/Namespaces.php
pngx_wyregraf_url_guard_allowed #
apply_filters( 'pngx_wyregraf_url_guard_allowed', bool $allowed, string $url, string[] $ips )Filters the final URL-guard verdict, e.g. to allow a known intranet host.
$allowed(bool) — Whether the URL may be fetched.$url(string) — The URL being validated.$ips(string[]) — The resolved IP addresses.
Since TBD · Source: Wyregraf/src/Http/URL_Guard.php
pngx_wyregraf_url_guard_ports #
apply_filters( 'pngx_wyregraf_url_guard_ports', int[] $ports, string $url )Filters the ports allowed for outbound fetches.
$ports(int[]) — The allowed ports.$url(string) — The URL being validated.
Since TBD · Source: Wyregraf/src/Http/URL_Guard.php
pngx_wyregraf_url_guard_resolver #
apply_filters( 'pngx_wyregraf_url_guard_resolver', string[]|null $ips, string $host )Filters the resolved IPs for a host before DNS is queried.
Returning a non-null array short-circuits resolution (test seam / custom resolver).
$ips(string[]|null) — The resolved IPs, or null to resolve via DNS.$host(string) — The host being resolved.
Since TBD · Source: Wyregraf/src/Http/URL_Guard.php
pngx_wyregraf_usage_cost #
apply_filters( 'pngx_wyregraf_usage_cost', float $cost, array $usage, string $model, string $service )Filters the computed dollar cost for one LLM request.
Lets site owners price models missing from the built-in pricing table (unpriced models record cost 0 but always record tokens).
$cost(float) — The computed cost.$usage(array) — The raw provider usage payload.$model(string) — The model name.$service(string) — The service id.
Since TBD · Source: Wyregraf/src/Usage/Usage_Recorder.php
pngx_wyregraf_usage_identity #
apply_filters( 'pngx_wyregraf_usage_identity', array $identity )Filters the caller identity used for usage recording and quota scoping.
Pro fills session_id / chat_group_id from the chat session; core supplies the WP user id and client IP.
$identity(array) — The identity map (user_id, session_id, ip, chat_group_id, sub_chat_uuid).
Since TBD · Source: Wyregraf/src/Security/Quota_Manager.php
pngx_wyregraf_vector_store_threshold #
apply_filters( 'pngx_wyregraf_vector_store_threshold', float $threshold, int $chat_post_id )Filter default vector store threshold.
$threshold(float) — Threshold for filtering scores.$chat_post_id(int) — Chat post ID, or 0.
Since 0.1.0 · Source: Wyregraf/src/Vector_Stores/Traits/Collection_Utilities.php
pngx_wyregraf_verify_answer_support #
apply_filters( 'pngx_wyregraf_verify_answer_support', array|null $output, string $question, string $answer, array $sources, int $chat_post_id )Filters the answer-support verification result before the accuracy profile is asked.
Return a non-null array to supply the verification output and skip the built-in LLM call.
$output(array|null) — The verification output, or null to use the accuracy profile.$question(string) — The user question.$answer(string) — The candidate answer.$sources(array) — The untouched evidence documents.$chat_post_id(int) — The chat post ID.
Source: Wyregraf/src/Grounding/Citation_Integrity.php
pngx_wyregraf_voyage_request_timeout #
apply_filters( 'pngx_wyregraf_voyage_request_timeout', int|float $timeout )Filters the HTTP timeout, in seconds, for Voyage AI embedding and rerank requests.
$timeout(int|float) — The request timeout in seconds. Default 15.
Source: Wyregraf/src/Services/Voyage/Embeddings.php
wp_pngx_session_cookie_name #
apply_filters( 'wp_pngx_session_cookie_name', string $, \Session_Cookie_Abstract $this )Allow filtering of the session cookie name.
The cookie name is prepended with wp, cache systems like batcache will not cache pages when set.
$(string) — The default cooke name session.$this(\Session_Cookie_Abstract) — The current session object.
Since 4.0.0 · Source: Wyregraf_Pro/src/Chat/Chat_Session.php
wyregraf_admin_menu_itmes #
apply_filters( 'wyregraf_admin_menu_itmes', (string|mixed)[] $wyregraf_menu, (string|mixed)[] $menu_items )Filter the Wyregraf Admin Menu Items.
$wyregraf_menu((string|mixed)[]) — An array of the Wyregraf Vector Menu items.$menu_items((string|mixed)[]) — An array of menu items.
Since 0.1.0 · Source: Wyregraf/src/Admin/Menu.php
wyregraf_analytics_admin_capability #
apply_filters( 'wyregraf_analytics_admin_capability', string $capability )Filters the capability required to view the Analytics screen.
$capability(string) — The capability, default manage_options.
Since TBD · Source: Wyregraf/src/Chats/Analytics/Page.php
wyregraf_analytics_retention_batch_size #
apply_filters( 'wyregraf_analytics_retention_batch_size', int $batch_size )Filters the analytics retention delete batch size.
$batch_size(int) — Rows per delete batch.
Since TBD · Source: Wyregraf/src/Chats/Analytics/Retention.php
wyregraf_analytics_tiles #
apply_filters( 'wyregraf_analytics_tiles', array $tiles, string $from_day, string $to_day )Filters the analytics summary tiles.
The basic dashboard ships volume/quality tiles only; add cost/token or other tiles here.
$tiles(array) — The tiles, each [ key, label, value ].$from_day(string) — The first day (Y-m-d).$to_day(string) — The last day (Y-m-d).
Since TBD · Source: Wyregraf/src/Chats/Analytics/Ajax.php
wyregraf_insights_admin_capability #
apply_filters( 'wyregraf_insights_admin_capability', string $capability )Filters the capability required to view and manage the Knowledge Gaps screen.
$capability(string) — The capability, default manage_options.
Since TBD · Source: Wyregraf/src/Chats/Insights/Page.php
wyregraf_insights_retention_batch_size #
apply_filters( 'wyregraf_insights_retention_batch_size', int $batch_size )Filters the insights retention delete batch size.
$batch_size(int) — Rows per delete batch.
Since TBD · Source: Wyregraf/src/Chats/Insights/Retention.php
wyregraf_pro_chat_group_get_chat_group_id #
apply_filters( 'wyregraf_pro_chat_group_get_chat_group_id', string|int $ )Filter when getting the chats id.
$(string|int) — of chats id.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_pro_chat_group_hash #
apply_filters( 'wyregraf_pro_chat_group_hash', string $hash, int|string $chats_session )Filter when getting the chats session hash.
$hash(string) — Hash for chats id.$chats_session(int|string) — The chats id.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_pro_chat_group_persistent_chats_enabled #
apply_filters( 'wyregraf_pro_chat_group_persistent_chats_enabled', bool $ )Filter whether persistent chats is enabled.
$(bool) — Whether the persistent chats is enabled. Default is true.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_pro_get_chat_group_from_session #
apply_filters( 'wyregraf_pro_get_chat_group_from_session', array $chat_data )Filter the chat data loaded from session.
$chat_data(array) — The chat data loaded from session.
Since 0.5.0 · Source: Wyregraf_Pro/src/Chat/Chat_Group.php
wyregraf_rest_openapi_documentation #
apply_filters( 'wyregraf_rest_openapi_documentation', (string|mixed)[] $documentation, \OpenAPI_Documentation $this )Filters the OpenAPI documentation generated for the TEC REST API.
$documentation((string|mixed)[]) — An associative PHP array in the format supported by OpenAPI.$this(\OpenAPI_Documentation) — This documentation endpoint instance.
Since 0.5.0 · Source: Wyregraf_Pro/src/REST/V1/Documentation/Abstract_OpenAPI_Documentation.php
wyregraf_rest_url #
apply_filters( 'wyregraf_rest_url', string $url, string $path, int $blog_id, string $scheme )Filters Wyregraf REST URL.
$url(string) — TEC REST URL.$path(string) — REST route.$blog_id(int) — Blog ID.$scheme(string) — Sanitization scheme.
Since 0.5.0 · Source: Wyregraf_Pro/src/REST/V1/Traits/REST_Namespace.php
wyregraf_rest_url_prefix #
apply_filters( 'wyregraf_rest_url_prefix', string $prefix, string $default_tec_prefix )Filters the Wyregraf Pro REST API URL prefix
$prefix(string) — The complete URL prefix.$default_tec_prefix(string) — The default URL prefix appended to the REST URL by Wyregraf.
Since 0.5.0 · Source: Wyregraf_Pro/src/REST/V1/Traits/REST_Namespace.php
wyregraf_rest_use_builtin #
apply_filters( 'wyregraf_rest_use_builtin', bool $use_builtin )Filters whether builtin WordPress REST API functions should be used or not if available.
$use_builtin(bool) — Whether to use builtin WordPress REST API functions.
Since 0.5.0 · Source: Wyregraf_Pro/src/REST/V1/Traits/REST_Namespace.php
wyregraf_setup_admin_capability #
apply_filters( 'wyregraf_setup_admin_capability', string $capability )Filters the capability required to view the Setup wizard.
$capability(string) — The capability, default manage_options.
Since 0.7.0 · Source: Wyregraf/src/Onboarding/Page.php
wyregraf_transcripts_admin_capability #
apply_filters( 'wyregraf_transcripts_admin_capability', string $capability )Filters the capability required to view and manage conversation transcripts.
$capability(string) — The capability, default manage_options.
Since TBD · Source: Wyregraf/src/Chats/Transcripts/Page.php
wyregraf_transcripts_chat_group_users #
apply_filters( 'wyregraf_transcripts_chat_group_users', array<string,array{user_id: int, display_name: string}> $map, string[] $group_ids )Filters the chat-group-to-user attribution map for the transcripts viewer.
Core has no user linkage (conversations belong to anonymous chat group UUIDs); pro resolves logged-in owners from its persistent-chats usermeta. Unmapped groups render as Guest.
$map(array<string,array{user_id: int, display_name: string}>) — The attribution map.$group_ids(string[]) — The chat group ids to resolve.
Since TBD · Source: Wyregraf/src/Chats/Transcripts/Ajax.php
wyregraf_transcripts_message_limit #
apply_filters( 'wyregraf_transcripts_message_limit', int $limit, string $chat_uuid )Filters the maximum number of messages returned per subchat transcript.
$limit(int) — The message cap.$chat_uuid(string) — The chat UUID.
Since TBD · Source: Wyregraf/src/Chats/Transcripts/Ajax.php
wyregraf_transcripts_retention_batch_size #
apply_filters( 'wyregraf_transcripts_retention_batch_size', int $batch_size )Filters the retention delete batch size.
$batch_size(int) — Conversations per delete batch.
Since TBD · Source: Wyregraf/src/Chats/Transcripts/Retention.php
